How to Become a Technical Writer
API docs, tutorials, developer guides, and content operations. Sits at the intersection of engineering, product, and writing craft.
1. Writing Foundations
coreClear Technical Writing
Short sentences, active voice, one idea per paragraph. Google's Tech Writing Course is the industry-default primer.
2. The Diátaxis Framework
core3. API Documentation
coreOpenAPI / Swagger
The industry standard for describing REST APIs. Learn to read a spec, contribute to one, and generate docs from it.
4. Developer Content
coreTutorial Writing
Task-focused, step-by-step, working code. If the reader can't finish the tutorial in one sitting, it's too long.
Conceptual / Explanation Docs
The 'why' docs. Diagrams, background, tradeoffs. Often the highest-leverage docs but the least written.
- docs free →
5. Docs Toolchain
coreDocs Site Generators
Docusaurus, MkDocs, Sphinx, VitePress, Nextra. Docs-as-code is the norm — pick your stack based on the engineering team's language.
Markdown, MDX, reStructuredText
The three docs authoring formats. MDX (Markdown + JSX) is dominant for interactive docs.
Git for Writers
Branches, PRs, code review. Docs-as-code means writers use engineering workflows.
- tutorial free →
6. Docs Ops & Content Strategy
recommendedDocs IA
Structure, navigation, findability. Card sorting for docs. Category vs product vs task grouping.
- docs free →
Docs Analytics
What pages get traffic, where users bail, what searches return zero results. Measure to improve.
- channel free →
7. Working with Engineering
coreReading Code
You can't document what you don't understand. Enough programming literacy to read the source you're writing about.
- tutorial free →
Docs Reviews in PRs
Docs live in the same repo as code. Review-driven docs quality is now the norm.
- docs free →
8. Specialisations
recommendedDevRel-Adjacent Writing
Blog posts, launch announcements, conference talks. Tech writers often bridge into DevRel.
- blog free →
UX Writing / Microcopy
In-product strings, error messages, empty states. A distinct craft from long-form docs.
- docs free →
9. AI in Docs
recommendedLLM-Assisted Drafting
First-draft acceleration, style-guide enforcement, translation. AI raises the floor; craft is the ceiling.
- course free →
10. Career & Voices
optionalWant a personalised version?
This roadmap is the same one our platform uses internally, but the logged-in version lets you tick off topics as you complete them, track a personalised First 90 Days plan, and see your AI-durability score against this role. All free.
Open the interactive roadmap →