Writing Fundamentals
- Writing for technical audiences
- Clarity and concision
- Active voice
- Structure and hierarchy
- Tone and consistency
Write documentation so clear that engineers stop asking questions.
Technical writers create documentation that makes complex systems understandable, API docs, user guides, tutorials, and changelogs. If you can write clearly about technical things, you are in demand.
Salary range: $50,000 to $120,000/year
Follow each stage in order. Mark stages complete as you finish them.
Google's free technical writing courses. Pre-course and main course. Essential starting point.
developers.google.com/tech-writing
Community-driven documentation best practices guide. The industry standard reference.
www.writethedocs.org/guide
The 4-type documentation framework: tutorials, how-tos, explanations, and references.
www.divio.com/blog/documentation
Complete reference for Markdown syntax, the format of most technical documentation.
www.markdownguide.org/cheat-sheet
Document a public API or one you built, endpoints, parameters, responses, errors.
Write a 3-part tutorial teaching a beginner to build something in your area of expertise.
Improve the documentation of a real open source project and submit a pull request.
Draft documentation, simplify text, consistency review
Grammar, tone, and readability checks
I have written this technical explanation but it is too long. Simplify it for junior developers who understand JavaScript but not React: [paste text]Generate an API reference entry for this endpoint formatted as Markdown with: Description, HTTP Method, URL, Request Parameters, Request Body, Response, Error Codes, and a code example: [paste details]$50,000 to $120,000/year
Technical writers who can read code earn significantly more than those who cannot. Even basic Python or JavaScript reading ability makes you far more effective and employable.