Technical Writing

Docs-as-Code: Treat Documentation Like Software

Learn docs-as-code: version control for documentation with Git, Markdown/AsciiDoc syntax, static site generators (Hugo, Docusaurus, MkDocs), CI/CD publishing, review workflows, doc linters (Vale, markdownlint), and automated testing for docs.

API Documentation: REST, GraphQL & SDK Docs Guide

Learn API documentation best practices: REST API endpoints and parameters, OpenAPI/Swagger specs, GraphQL docs with GraphiQL, SDK documentation patterns, authentication docs, multi-language code examples, and doc generators like Redoc and Stoplight.

README: The Complete Guide to Writing Great READMEs

Learn how to write great README files: structure (name, description, install, usage, API, contributing, license), badge systems, screenshots/GIFs, code of conduct, README generators, examples of great READMEs, and README-driven development.

Technical Blogging: Write Tutorials That Rank and Teach

Learn technical blogging: choosing topics with keyword research and gap analysis, tutorial structure (hook, prerequisites, steps, summary), code formatting, screenshots and diagrams, SEO for technical posts, content promotion strategies, and building an audience.

Technical Style Guides: Consistent Documentation Standards

Learn technical style guides: Google Developer Documentation Style Guide, Microsoft Style Guide, terminology management, voice and tone (active voice, second person), formatting conventions, internationalization, automated style checking with Vale, and creating your own style guide.

Diagram-as-Code: Mermaid, PlantUML & Structurizr Guide

Learn diagram-as-code: Mermaid syntax (flowcharts, sequence diagrams, Gantt, class diagrams), PlantUML for UML diagrams, Structurizr with C4 model, embedding in docs, rendering in CI, version control for diagrams, and tool comparison.

Writing for Developers: Communicate Complex Technical Concepts

Learn how to write for developers: understanding the developer audience, explaining complex concepts, code examples that teach, error messages and troubleshooting docs, API reference vs guides vs tutorials, cognitive load reduction, progressive disclosure, and inclusive language.

Documentation Tools: Docusaurus, Hugo, ReadTheDocs & More

Learn documentation tools: static site generators comparison (Docusaurus, Hugo, MkDocs, Jekyll), hosting platforms (ReadTheDocs, Netlify, Vercel, GitHub Pages), doc portals (GitBook, Mintlify), knowledge bases (Notion, Confluence), search tools (Algolia, Meilisearch), analytics, and feedback collection.

Information Architecture: Content Organization, Navigation, and Search

Learn information architecture for technical documentation: content organization models, navigation design, search optimization, taxonomy and metadata, and how to structure documentation for findability.

Developer Portal Guide: API Portals, SDK Docs, and Interactive Playgrounds

Learn how to build a developer portal: API reference documentation, SDK guides, interactive API playgrounds, authentication guides, and how to create a great developer experience (DX) that drives adoption.

Open Source Documentation: Contributing Guides, Community Docs, and README Best Practices

Learn open source documentation: writing effective contributing guides, maintaining community documentation, README best practices, licensing, code of conduct, and building a documentation culture in open source projects.

Video Tutorial Creation: Scripting, Screen Recording, Editing, and Platform Optimization

Learn video tutorial creation: writing effective scripts and storyboards, screen recording tools and techniques (OBS, ScreenFlow), editing workflows, optimizing for YouTube and social platforms, and measuring engagement.

Content Strategy for Documentation: Audience Analysis, Audits, and Editorial Calendars

Learn content strategy for technical documentation: audience analysis and personas, content audits and gap analysis, editorial calendars, content lifecycle management, and measuring content effectiveness.

SEO for Technical Writing: Keyword Research, Snippets, and Structured Data

Learn SEO for technical documentation: keyword research for developer content, optimizing for Google featured snippets, structured data (FAQ, HowTo, Article schema), and technical SEO best practices for docs sites.

Documentation Localization: i18n Tools, Translation Workflows, and Locale Adaptation

Learn documentation localization: internationalization (i18n) tools like Crowdin and Transifex, translation workflows, managing translated content in static sites, locale adaptation beyond translation, and quality assurance.