Technical writing
TEK-nih-kul RY-ting
Writing that explains complex technical concepts clearly, including documentation, tutorials, API references, and guides.
Technical writing translates complex ideas into clear instructions. In tech companies, technical writers produce documentation, API references, tutorials, quickstart guides, and troubleshooting content. The goal is to help someone accomplish a task without confusion.
Good technical writing is invisible. The reader does not notice the writing. They just understand what to do. Bad technical writing makes the reader stop and reread sentences, guess at ambiguous instructions, or give up entirely.
For developer tools, technical writing is the product experience. Developers encounter documentation before they encounter the product itself. If the docs are confusing, developers leave. Stripe, Twilio, and Vercel are all known for exceptional documentation because they invested in technical writing as a first-class discipline, not an afterthought.
Examples
A developer reads a quickstart guide.
The guide takes the developer from zero to a working 'Hello World' in under 5 minutes. Each step is numbered, includes a code sample, and shows the expected output. No step requires prior knowledge that was not covered in a previous step.
A technical writer improves an error message.
The original error: 'Error 403.' The rewrite: 'Authentication failed. Your API key does not have permission to access this endpoint. Check that you are using a production key, not a test key.' The rewrite tells the developer what went wrong and how to fix it.
A company hires its first technical writer.
The writer audits the existing documentation and finds 30% of pages are outdated. Code samples use deprecated API versions. The quickstart assumes knowledge of tools the target audience may not have. The writer creates a plan to fix all three issues.
In practice
Read more on the blog
Frequently asked questions
What skills does a technical writer need?
Clear writing, attention to detail, ability to learn technical concepts quickly, empathy for the reader, and comfort with tools like Markdown, Git, and static site generators. The best technical writers combine writing skill with technical understanding.
Is technical writing the same as documentation?
Documentation is one output of technical writing, but not the only one. Technical writers also produce tutorials, blog posts, error messages, UI text, release notes, and internal knowledge bases.
Related terms
Writing text that persuades people to take a specific action, like clicking a button, signing up, or buying a product.
A regularly updated section of a website where a company publishes articles to attract, educate, and engage its target audience.
The plan for creating, publishing, and governing content that achieves specific business goals for a defined audience.
Want the complete playbook?
Picks and Shovels is the definitive guide to developer marketing. Amazon #1 bestseller with practical strategies from 30 years of marketing to developers.