Stage 1 · Lesson 3 of 9
Technical writer: making products usable through docs
create the documentation people use to succeed with a product. That includes getting started guides, , references (exact descriptions of how to use a product from code), troubleshooting pages and release notes.
On a normal day they learn a feature from engineers and try it themselves. They decide how the information should be organised, then write and test the pages and get them reviewed. In many software teams, docs live in as Markdown files.
Git is a system that tracks every change to files, and Markdown is a simple text format. Changes to docs go through pull requests, the same review step used for code. People who do well are patient, precise, curious about how things work and happy to rewrite.
Common trapthinking the job is grammar and polish. Most of it is understanding the product and the reader, and a beautifully written page with a wrong step is worse than a plain one that works.
A question to check yourself, an AI practice session and 1 cheat sheet entry come with the full roadmap. Unlock
Resources for this stage
Start with
- GuideFreeThe Business Analysis Standard
IIBA · Beginner
IIBA's free, short standard: the core concepts and knowledge areas of business analysis in plain terms