Technical Writing
Creating clear, accurate documentation for technical products — including API docs, user guides, release notes, and internal knowledge bases.
Technical writing is the discipline of explaining complex systems, processes, or products in clear, structured prose targeted at a specific audience. It's required for dedicated technical writer roles (common at developer tool companies and large tech organizations) and expected as a secondary skill for product managers, engineering managers, and DevOps engineers responsible for documentation.
Typical time to job-readiness: ~2 months.
Learning Technical Writing
Beginner
Write a tutorial or README for an existing tool or project. Focus on audience awareness: who will read this and what do they already know? Structure matters more than prose quality.
Intermediate
Document an API with OpenAPI/Swagger, write a user guide for a non-technical audience, and build internal runbooks. Learn docs-as-code workflows (Markdown + Git).
Advanced
Lead a documentation strategy, implement a style guide, and measure documentation quality through user feedback and search analytics. Senior technical writers function as product owners of the knowledge base.
Key concepts
- Audience analysis — who is reading this, what do they already know, what do they need to do
- Task-based structure — organize around what the user wants to accomplish, not how the system is built
- Minimalism: include only what the reader needs; every extra sentence increases cognitive load
- Docs-as-code — write in Markdown, version in Git, review in pull requests like software
- Screenshots and code samples — show don't tell; but keep them up to date or they undermine trust
- Style guide — consistent terminology, voice, and formatting makes documentation feel like a product
Common interview topics
- Walk me through a documentation project you're proud of — what was the challenge and what did you do
- How do you decide what to document and what level of detail to include
- How do you approach writing for a non-technical audience
- How do you keep documentation accurate when the product changes frequently
- What is your process for getting technical review on documentation you write