Ttechwriter.dev

THE RESOURCE REVIEW

20 places to sharpen your practice.

A curated selection of primary resources, assessed for authority, practical depth, and relevance—not a traffic or search-engine ranking.

How to use this review

Choose by your current task. “Best fit” reflects our editorial assessment of the linked resource. Product capabilities and commercial terms can change; check the source before adopting a tool. Reviewed 6 October 2026.

01
Foundations

Write the Docs

Broad community guidance spanning writing, accessibility, tools, and documentation operations.

Keep in mind

A reference collection rather than a single linear course.

Apply it

Give readers a clear learning route and connect writing practice to maintenance.

02
Foundations

Google for Developers

Structured technical-writing lessons and a detailed developer documentation style guide.

Keep in mind

Its examples and conventions primarily serve technical practitioners.

Apply it

Combine short explanations with editing exercises and an explicit house style.

03
Style

Microsoft Writing Style Guide

Practical terminology and voice guidance for technology communication.

Keep in mind

Product-specific conventions need judgment outside the Microsoft ecosystem.

Apply it

Use consistent interface names and direct, helpful instructions.

04
API documentation

I’d Rather Be Writing

An extensive API documentation course alongside practitioner discussion of tools, careers, and AI.

Keep in mind

The broad blog archive needs a focused reading path.

Apply it

Teach the full API journey, from a first request to reference and testing.

05
Structure

Diátaxis

Distinguishes tutorials, how-to guides, reference, and explanation by user need.

Keep in mind

A framework does not supply your product facts or publishing workflow.

Apply it

Label each guide’s purpose and keep reference details easy to locate.

06
Structure

Divio Documentation System

A concise introduction to four documentation purposes with linked explanations.

Keep in mind

Conceptually overlaps with Diátaxis; it is not independent validation of the framework.

Apply it

Show how one product feature can require several different document types.

07
Style

MDN Web Docs

Concrete authoring guidance, page structures, examples, and contribution policies.

Keep in mind

Its content model is tailored to web technology documentation.

Apply it

Give articles repeatable structures and identify technical facts that need verification.

08
Workflow

Docs Like Code

Explains Git, reviews, and automated publishing as a collaborative documentation workflow.

Keep in mind

Teams still need to choose tools and establish ownership.

Apply it

Teach a small edit–review–publish cycle before adding advanced automation.

09
Workflow

GitHub Docs

Publishes its content model, style guide, and contribution practices.

Keep in mind

GitHub-specific structures should be adapted rather than copied wholesale.

Apply it

Document contribution rules and supply reviewer checklists.

10
Workflow

GitLab Docs

Makes documentation changes, technical-writer involvement, testing, and review visible.

Keep in mind

Its contribution process reflects a large product organization.

Apply it

Assign an owner and review path to every important guide.

11
Tools

Sphinx

Rich cross-references, extensibility, multiple output formats, and code-reference support.

Keep in mind

More configuration and markup concepts than a minimal writing workflow.

Apply it

Consider it when code references and structured cross-links are central.

12
Tools

MkDocs

A focused documentation generator built around Markdown and YAML configuration.

Keep in mind

Advanced needs may depend on themes, plugins, and their maintenance.

Apply it

Use a small Markdown project to teach publishing fundamentals.

13
Tools

Docusaurus

A documentation-site framework with a dedicated getting-started and configuration guide.

Keep in mind

A JavaScript site introduces a build toolchain that writers must maintain or delegate.

Apply it

Evaluate it when documentation needs a more customized web experience.

14
Publishing

Read the Docs

Git-based builds, versioned documentation, previews, and publishing guidance.

Keep in mind

Hosting automation cannot verify the accuracy of the prose it publishes.

Apply it

Keep review previews and documentation versions tied to releases.

15
Quality

Vale

Configurable prose linting helps multiple authors apply a shared style.

Keep in mind

It is not a general grammar checker or a test of technical truth.

Apply it

Automate repeatable terminology checks while retaining human review.

16
Tools

Asciidoctor

Guidance for AsciiDoc authoring and conversion to several publishing formats.

Keep in mind

Authors must learn a richer markup syntax and the chosen conversion workflow.

Apply it

Evaluate structured plain-text authoring when manuals need reusable conventions.

17
API documentation

Swagger

Explains OpenAPI descriptions and the tools that turn them into usable API documentation.

Keep in mind

The reviewed guide targets OpenAPI 3.0; match guidance to your actual specification version.

Apply it

Pair a machine-readable contract with a tested task-based quickstart.

18
API documentation

Redocly

Documentation for OpenAPI linting, validation, transformation, and rendered reference.

Keep in mind

Separate the open-source tools from commercial platform capabilities when evaluating a workflow.

Apply it

Validate the API description before publishing generated reference pages.

19
Accessibility

W3C Web Accessibility Initiative

Actionable writing guidance for headings, links, alternatives, instructions, and multimedia.

Keep in mind

A writing checklist alone does not establish whole-site accessibility conformance.

Apply it

Review semantic structure, meaningful links, and alternatives alongside visual presentation.

20
API documentation

Stripe Docs

A real API reference that identifies base URL, libraries, sandbox behavior, and version context.

Keep in mind

A product-specific example, not a universal API or writing standard.

Apply it

Make environment, authentication, and version assumptions visible to readers.