Foundations / How-to
Build a practical technical-writing portfolio
Show research, writing, and testing through a small set of useful samples.
Choose an accessible subject
Pick a tool you can actually use and document. Choose a task that is small enough to test end to end. Avoid relying on confidential workplace material or claiming authorship of someone else’s documentation.
Create three complementary samples
Write a beginner tutorial, a task-focused how-to, and a compact reference entry. Add a short explanation of the audience, your research method, and what you tested. Show a before-and-after revision when it demonstrates a real improvement.
Develop the workflow
Practice Markdown, version control, review, and publishing on your sample project. For developer documentation, add a tested API task. Use the linked courses and community resources to fill specific skill gaps.
Make evidence visible
State your role, scope, and constraints. Describe feedback you received and the resulting change. Do not invent usage metrics, employment experience, certifications, or business outcomes; a well-tested sample is valuable on its own.
Sources & further reading
Original guidance and examples by TechWriter, informed by these resources.