Projects for Technical Writers
Technical writing projects are portfolio pieces that show you can do the work end to end. Typical projects are documenting a public API with a quickstart and tutorials, building a docs site with CI and style linting, and rewriting a poor README into a complete documentation set. Each should be public, reviewed and explained in a short case study.
Stage: Capstone and Career · Part of the Technical Writer roadmap · Last reviewed 19 November 2026
What to learn in Projects
- Select a public API and document it with a reference and tutorial
- Publish a docs site with automated builds, link checks and linting
- Rewrite a weak README into a structured set of pages
- Write a short case study of the problem, process and result
- Collect feedback from a developer and revise the project
Projects interview questions
What makes a good technical writing portfolio project?
It documents a real product or API, shows range, such as a tutorial, a reference and a how-to guide, is publicly viewable and has been tested by following its own steps. A short note on audience, choices and outcome shows your thinking.
How can you document a product you do not work on?
Pick an open source project or public API, use it hands-on, and write the docs a new user needs, such as a quickstart or a missing guide. Contribute through a pull request if the project accepts it, and be clear in your portfolio that it is your own work.
Where Projects fits in the Technical Writer roadmap
Projects belongs to the Capstone and Career stage (intermediate level), which takes about 6 hours. Build a portfolio.
Other units in this stage
Back to the full Technical Writer roadmap