Technical Writing

Plain Language Writing: Clear Communication for Technical Audiences

Learn how to write in plain language that non-experts can understand, using simple words, short sentences, and logical structure for better comprehension.

Active vs Passive Voice: Choosing the Right Voice for Technical Docs

Learn when to use active versus passive voice in technical writing, with practical examples showing how voice choice affects clarity and reader engagement.

Sentence Length Control: Improving Readability in Technical Content

Learn how to control sentence length in technical documentation to improve readability, reduce cognitive load, and make complex ideas easier to understand.

Paragraph Structure: Organizing Ideas for Maximum Clarity

Learn how to structure paragraphs in technical documentation with topic sentences, supporting details, and logical transitions for coherent reader experience.

Parallel Construction: Writing Balanced Lists and Sentences

Learn how to use parallel construction in technical writing to create balanced lists, consistent phrasing, and easier-to-scan documentation for all readers.

Inclusive Language: Writing Documentation That Welcomes Everyone

Learn how to use inclusive language in technical documentation, avoiding bias, using gender-neutral terms, and respecting diverse global audiences effectively.

Global English Basics: Writing for International Audiences

Learn Global English principles for technical documentation using simplified vocabulary, consistent terminology, and cultural awareness for readers worldwide.

Simplified Technical English: ASD-STE100 Standards for Clear Docs

Learn Simplified Technical English standards to create documentation that is unambiguous, easy to translate, and accessible to non-native English speakers.

Controlled Language: Restricting Vocabulary for Consistency

Learn how controlled language restricts vocabulary and grammar rules to produce technical documentation that is consistent, predictable, and machine-readable.

Terminology Management: Maintaining Consistent Technical Terms

Learn terminology management strategies to maintain consistent use of technical terms across large documentation projects and multiple translation workflows.

Documentation Types: A Complete Guide to Technical Documentation Categories

Learn the 8 core types of technical documentation including tutorials, how-to guides, reference docs, and conceptual explanations. Master when and how to use each type for clear developer documentation.

Glossary Development: Building a Comprehensive Term Reference

Learn how to develop and maintain a technical glossary with clear definitions, examples, and cross-references that support both readers and translators.

Style Guide Development: Creating Standards for Documentation Teams

Learn how to develop a comprehensive style guide for technical documentation teams, covering voice, tone, formatting conventions, and editorial standards.

Technical Writing Style — Clarity, Consistency, and Voice Standards

Learn technical writing style principles for clear documentation: active voice, audience awareness, plain language, sentence and paragraph structure, terminology consistency, and voice management for developer docs.

Microcopy Writing: Crafting Small UI Texts with Big Impact

Learn microcopy writing techniques for buttons, labels, placeholders, and confirmations that guide users through interfaces with clarity and personality.

Style Guides — Complete Guide to Documentation Standards

Learn about technical style guides including Google Developer, Microsoft, Apple, and Chicago Manual of Style. Master abbreviations, capitalization, punctuation, numbers, and code styling for consistent developer documentation.

UI Text Writing: Designing Clear and Concise Interface Copy

Learn how to write effective UI text including menus, dialogs, notifications, and help text that reduces confusion and improves the overall user experience.

Writing for Developers — Communicate Complex Technical Concepts Clearly

Learn how to write for developers: understand the developer audience, write effective code examples, explain complex concepts, create API documentation, error messages, changelogs, migration guides, and SDK docs.

Code Commenting Guide — Writing Comments That Help Developers

Learn how to write effective code comments including comment types, when to comment vs refactor, docstrings for functions and classes, inline comments for why-not-what, and automated documentation generation tools.

Error Message Writing: Turning Frustration into Understanding

Learn how to write error messages that explain what went wrong, why it happened, and how users can fix it, reducing frustration and support tickets overall.

Notification Writing: Effective System and User Alerts

Learn how to write system and user notifications that convey urgency, provide actionable information, and respect user attention without being intrusive.

Writing Tutorials Guide — Teaching Developers Through Effective Tutorials

Learn how to write effective programming tutorials that teach beginners and advanced developers alike. Master tutorial structure, audience analysis, code examples, troubleshooting, and building complete tutorial series.

API Documentation Guide

Learn API documentation from start to finish: OpenAPI specs, REST endpoints, GraphQL schemas, SDK docs, authentication, error handling, and documentation tools like Swagger and Redoc.

Tooltip Writing: Concise Help Text for Interface Elements

Learn how to write tooltips that provide just-in-time help for interface elements, balancing brevity with clarity so users understand functionality at a glance.

Onboarding Text: Writing First-Use Experiences That Convert

Learn how to write onboarding text that guides new users through first-time setup, explains key features, and reduces abandonment during product activation.

Writing API Documentation — Complete Guide

Learn how to write API documentation that developers love: endpoint descriptions, parameter docs, request/response examples, error messages, authentication guides, and changelog writing.

README Guide

Learn how to write great README files: project description, installation guide, usage examples, API reference, configuration, contributing guide, badges, license, and templates.

User Journey Mapping: Documenting End-to-End User Experiences

Learn how to create user journey maps that document every touchpoint, pain point, and emotion users experience when interacting with your product or service.

Docs-as-Code: Treat Documentation Like Software

Docs-as-code applies software engineering practices — version control, CI/CD, linting, code review — to documentation. Learn Git, Markdown, static site generators, and automated pipelines for docs.

Task Analysis Writing: Breaking Down User Goals into Steps

Learn how to write task analyses that break complex user goals into discrete steps, identifying key pain points and documentation needs at each stage.

Documentation Tools Comparison: SSGs, Platforms, and APIs

Compare documentation tools across static site generators (Hugo, Docusaurus, MkDocs, 11ty, Gatsby), hosted platforms (ReadMe, GitBook, Swimm), API doc tools (Swagger, Stoplight), and knowledge bases to choose the right stack.

User Flow Documentation: Mapping Navigation and Decision Paths

Learn how to document user flows that map navigation paths, decision points, and system interactions to create clear reference materials for design teams.

Documentation Tools: Editors, SSGs, Hosting, and Analytics

Explore documentation tools across the full stack — Markdown editors, static site generators (Hugo, MkDocs, 11ty), API doc tools (Swagger, Redoc, Stoplight), hosting platforms, collaboration, diagramming, linting, and analytics.

Scenario Description: Writing Real-World Use Cases for Products

Learn how to write scenario descriptions that illustrate real-world product use cases, helping readers understand context, goals, and expected outcomes.

Developer Portal Guide: APIs, SDKs, and Interactive Playgrounds

Build a developer portal that drives API adoption — API reference docs, SDK guides, interactive code playgrounds, authentication setup, changelogs, community forums, and analytics integration for developer experience.

Persona-Based Writing: Tailoring Content to Different Audiences

Learn how to write documentation targeting specific user personas, adapting tone, complexity, and content structure to meet the needs of diverse audiences.

Accessibility Writing: Creating Docs Usable by Everyone

Learn accessibility writing principles for technical docs including readable fonts, logical heading hierarchies, and content compatible with screen readers.

Content Strategy for Documentation: Planning, Audits, and Governance

Content strategy for technical documentation covers audience analysis, persona creation, content audits, gap analysis, editorial calendars, information architecture, SEO strategy, governance, and maintenance planning.

Information Architecture: Organize Content for Findability

Information architecture (IA) structures, labels, and organizes content so users find information quickly. Learn taxonomy, hierarchy, navigation, card sorting, tree testing, sitemaps, breadcrumbs, and cross-referencing.

Screen Reader Text: Writing Non-Visual Content Descriptions

Learn how to write text that screen readers interpret correctly, including proper heading levels, link text, image descriptions, and meaningful content order.

Alt Text Writing: Describing Images for Accessibility and SEO

Learn how to write effective alt text for technical documentation images, balancing accessibility needs with SEO benefits and context-appropriate descriptions.

Contributing to Documentation: Open Source and Community Docs

Learn how to contribute to documentation projects — finding good first issues, understanding contributing guides, writing style-adherent PRs, navigating code review, building a portfolio through open source contributions.

Closed Caption Writing: Transcribing Video Tutorials Accurately

Learn how to write closed captions for technical video content including speaker IDs, code snippets, and timing synchronization for accessibility compliance.

Technical Blog Writing — Complete Guide for Developers

Learn how to write technical blog posts that rank in search and teach developers effectively, covering topic selection, tutorial structure, SEO, code formatting, and promotion strategies.

Multilingual Documentation: Managing Content Across Languages

Learn strategies for managing multilingual documentation including translation workflows, content sync, and consistency across different language versions.

Technical Diagrams — Visual Communication for Developers

Learn how to create effective technical diagrams using Mermaid, Excalidraw, and Draw.io — covering flowcharts, architecture diagrams, sequence diagrams, and best practices for documentation.

Diagram-as-Code — Version-Controlled Visual Documentation

Master diagram-as-code with Mermaid, PlantUML, Structurizr, and D2 — write diagrams in text, render automatically, review in pull requests, and keep them in sync with code.

Translation Workflow: From Source Content to Localized Versions

Learn how to set up a translation workflow for technical documentation including file prep, translator handoff, quality checks, and publishing across locales.

Localization Basics: Adapting Content for Global Markets

Learn localization fundamentals for technical documentation including date formats, currency, cultural references, and regional compliance requirements.

Video Tutorial Creation — Scripting, Recording, and Publishing

Learn how to create professional video tutorials: script writing, screen capture with OBS and Camtasia, audio recording, editing basics, annotations, captions, and platform publishing.

Internationalization Guide: Designing Docs for Easy Translation

Learn how to design technical documentation for internationalization including encoding, text expansion, string externalization, and locale-aware templates.

SEO for Technical Writing — Documentation That Ranks

Learn SEO for technical documentation: keyword research for developer content, title and meta optimization, heading structure, internal linking, structured data, and technical SEO for docs sites.

Documentation Localization — i18n and l10n for Technical Content

Learn documentation localization: internationalization vs localization, translation workflows, machine and human translation, translation memory, glossary management, pseudo-localization, and tools like Crowdin.

Terminology Consistency: Keeping Terms Uniform Across Languages

Learn how to enforce terminology consistency across translated documentation using glossaries, term bases, and automated validation in localization workflows.

Open Source Documentation — README, Contributing, and Community Docs

Learn open source documentation best practices: writing README files that drive adoption, creating contributing guides, maintaining code of conduct, changelogs, governance docs, and community documentation.

Translation Memory: Leveraging Past Translations for Efficiency

Learn how translation memory systems store and reuse translated segments to improve consistency, reduce costs, and speed up documentation localization projects.

Machine Translation Post-Editing: Refining Automated Translations

Learn how to post-edit machine-translated technical content, balancing speed and quality by correcting terminology, grammar, and cultural appropriateness.

Technical Writing Portfolio — Build Your Writing Career

Build a technical writing portfolio that lands clients and jobs: writing samples, case studies, before-after transformations, open source contributions, blog posts, and portfolio platforms for career success.

Documentation Testing Methodology: Validating Accuracy and Clarity

Learn documentation testing methods including technical accuracy reviews, readability scoring, usability testing, and automated link and format validation.

Usability Testing for Documentation: Measuring Reader Success

Learn how to conduct usability testing on technical documentation by observing real users, measuring task completion, and identifying confusing content areas.

Document Review Workflow: Structured Peer and Expert Reviews

Learn how to establish a structured document review workflow with assigned roles, review stages, feedback tracking, and approval gates for quality assurance.

Peer Review Checklist: Evaluating Documentation for Quality

Learn how to use a peer review checklist for technical documentation covering accuracy, completeness, clarity, consistency, and style guide adherence.

Editorial Review: Polishing Technical Content Before Publication

Learn how to conduct editorial reviews of technical documentation including grammar, tone, structural improvements, and style guide compliance checks.

Subject Matter Review: Validating Technical Accuracy in Docs

Learn how to conduct subject matter expert reviews that verify technical accuracy, code correctness, architectural precision, and domain-specific terms in docs.

Technical Review Process: Involving Engineers in Documentation

Learn how to run a technical review process that engages engineers to validate documentation accuracy without creating bottlenecks in the publishing workflow.

Documentation QA Process: Ensuring Quality Before Publishing

Learn how to build a documentation quality assurance process with automated checks, manual reviews, link validation, and formatting verification steps.

Documentation Metrics: Measuring Content Performance and Impact

Learn how to measure documentation effectiveness using metrics like page views, search rankings, time on page, support ticket deflection, and user satisfaction.

Documentation ROI: Proving the Business Value of Technical Writing

Learn how to calculate documentation ROI by measuring reduced support costs, faster onboarding, lower error rates, and improved customer retention numbers.

Content Audit Methodology: Evaluating Documentation Inventory

Learn content audit methods to evaluate your documentation inventory for accuracy, relevance, duplication, gaps, and alignment with current product features.

Content Gap Analysis: Identifying Missing Documentation Topics

Learn how to perform content gap analysis by comparing existing documentation against user needs, support tickets, feature releases, and competitor coverage.

Content Health Assessment: Scoring Documentation Quality

Learn how to assess documentation health using criteria like freshness, accuracy, completeness, and readability to prioritize improvement efforts effectively.

Documentation Version Control: Managing Multiple Doc Versions

Learn version control for documentation across multiple product releases using branching strategies, version tags, and conditional content techniques.

Branch-Based Documentation: Aligning Docs with Code Branches

Learn branch-based documentation workflows where documentation versions align with code branches, enabling synchronized releases and effective rollbacks.

Docs Like Code: Applying Software Engineering Practices to Docs

Learn the docs-like-code philosophy that applies version control, code review, continuous integration, and automated testing to documentation workflows.

Continuous Documentation: Keeping Docs Updated with Every Release

Learn continuous documentation practices that integrate documentation updates into the development workflow, ensuring docs stay current with every code change.

Documentation Pipeline Automation: Building and Deploying Docs

Learn how to automate documentation pipelines with CI, static site generation, link checking, and automated deployment to documentation hosting platforms.

Vale Linter: Automated Prose Checking for Technical Writing

Learn how to use Vale, the open-source prose linter, to enforce style guides, check grammar, and maintain consistent terminology across documentation projects.

Write Good Linter: Improving Readability with Automated Checks

Learn how to use the write-good linter to catch weasel words, passive voice, jargon, and readability issues in technical documentation before publication.

Proselint: Comprehensive Prose Linting for Documentation Teams

Learn how to use Proselint for comprehensive prose linting that checks grammar, style, redundancy, and readability across large documentation codebases.