TSH

Technical Writing

Write documentation so clear that engineers stop asking questions.

Beginner-Friendly2 to 3 monthsdesign
Your Progress0%

Overview

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.

Who is this for?

  • Students starting from zero who want structure
  • Self-taught learners who need a clear path
  • Career switchers ready to commit consistently

What can you build?

  • API documentation
  • User manuals and guides
  • Developer tutorials
  • Internal knowledge bases
  • Product changelogs

Jobs you can get

Technical WriterDocumentation EngineerDeveloper AdvocateContent Engineer

Salary range: $50,000 to $120,000/year

Roadmap

Follow each stage in order. Mark stages complete as you finish them.

  1. Stage 12 to 3 weeks

    Writing Fundamentals

    • Writing for technical audiences
    • Clarity and concision
    • Active voice
    • Structure and hierarchy
    • Tone and consistency
  2. Stage 22 to 3 weeks

    Tools & Formats

    • Markdown mastery
    • Docs as Code (Git)
    • Confluence / Notion
    • ReadMe.com
    • Diagrams (Mermaid, Excalidraw)
  3. Stage 33 to 4 weeks

    Documentation Types

    • API documentation
    • Tutorial writing
    • How-to guides
    • Conceptual explanations
    • Reference documentation
  4. Stage 4Ongoing

    Portfolio & Specialization

    • Technical writing portfolio
    • Specializing by domain
    • Writing for open source

Resources

Projects

beginner

#01

API Documentation

Document a public API or one you built, endpoints, parameters, responses, errors.

MarkdownReadMeAPIs

intermediate

#01

Tutorial Series

Write a 3-part tutorial teaching a beginner to build something in your area of expertise.

Docs as CodeMarkdownGit

advanced

#01

Open Source Contribution

Improve the documentation of a real open source project and submit a pull request.

GitHubMarkdownOpen Source

AI Guide

What AI helps with

  • Drafting first versions of documentation sections
  • Simplifying overly complex sentences
  • Generating API reference templates
  • Proofreading and consistency checking

What AI cannot replace

  • Understanding the technical systems you are documenting
  • Replacing clarity of thought with generated text

Recommended Tools

Sample Prompts

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]

Career Path

Technical WriterDocumentation EngineerDeveloper AdvocateContent Engineer

$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.