This module is designed to equip you with everything you need to establish a polished, public-facing documentation portfolio, prepare for job interviews, and communicate your value to prospective employers or clients. You will:
- Build and publish a documentation portfolio on GitHub Pages, Notion, or a custom site
- Optimize your resume and LinkedIn profile for technical writing opportunities
- Understand the nuances between freelance and full-time roles
- Explore where to find high-quality documentation jobs
- Deliver a final professional documentation project with key deliverables
Your portfolio should tell the story of your capability, flexibility, and specialization in technical communication. It should present both your polished documentation and your process, showcasing how you think, plan, and communicate.
Case studies highlight the story behind the documentation:
- What was the product?
- Who was the audience?
- What challenges did you face?
- What strategies did you employ?
I documented a complex user onboarding flow for a mobile fintech application. The audience was a non-technical user base with minimal digital finance literacy. I conducted audience research via support tickets, built a modular guide system, and reduced onboarding errors by 35% post-implementation.
These types of stories show potential employers how you operate in real contexts.
No modern portfolio is complete without an example of API documentation, especially for technical writing roles in developer-focused companies.
Key features to include:
- Authentication flow
- Endpoint structure
- Parameters and response types
- Request/response examples (JSON, XML)
- Pagination and rate limiting
- Error codes and troubleshooting
Tools such as Swagger, Redocly, Postman, and Stoplight help you generate interactive API references.
Effective tutorials illustrate your ability to teach. These are ideal for demonstrating:
- Clarity of communication
- Audience awareness (beginner to advanced)
- Logical sequencing of tasks
- Visual assets (e.g., screenshots, diagrams, screencasts)
Pick a topic you understand well. For example, "How to Set Up a CI/CD Pipeline with GitHub Actions" or "Beginner’s Guide to Creating Python Packages."
User guides provide navigable, well-structured explanations for real-world product use. These showcase:
- Navigation structures (TOCs, breadcrumbs, etc.)
- Consistency in tone and layout
- Thoughtful UX (search, anchors, hyperlinks)
- Coverage of common workflows, edge cases, and troubleshooting
Pair these with an FAQ to reinforce your user-first writing philosophy.
Recruiters typically scan resumes in under 10 seconds. To stand out:
- Use action verbs: Created, Implemented, Reduced, Led
- Show metrics: "Improved product documentation adoption by 40%"
- Emphasize impact: "Reduced ticket volumes by 25% by building searchable help docs"
- Focus on tools and formats: Markdown, Git, API, Agile, Sphinx, Docusaurus, Notion
Your LinkedIn is often the first impression after your name.
Checklist:
- ✅ Profile photo: Clear and professional
- ✅ Headline: "Technical Writer | API Docs | Developer Education | UX Content"
- ✅ Summary: Write a short narrative of your writing journey and specialties
- ✅ Experience: Use bullet points, match keywords to your ideal job titles
- ✅ Featured: Showcase links to your portfolio and case studies
Request endorsements from collaborators and clients when possible.
Understanding these two major career paths is crucial for defining your direction.
Freelancers often work with startups, agencies, or SaaS companies that need contractual documentation support.
- Flexible schedule and location
- Exposure to a variety of industries and tools
- Potential for higher hourly earnings
- Income variability
- You are your own boss and sales team
- You must handle invoices, taxes, and project scope
Pro Tip: Use tools like Bonsai or HelloBonsai for contracts and payments.
In-house writers embed with dev teams, often from feature planning through release.
- Stable salary and benefits
- Long-term product knowledge
- Cross-functional collaboration (PMs, designers, engineers)
- Less project diversity
- Risk of documentation being deprioritized
- Often a single toolset or style guide to adhere to
In-house roles are excellent for those who value consistency, team culture, and growth within an organization.
The internet is flooded with job boards—but only some truly cater to technical documentation.
- We Work Remotely
- Technical Writer HQ
- GitHub Jobs
- Upwork
- Write the Docs
- Wellfound (formerly AngelList)
Set up job alerts with the keywords:
- “Technical Writer”
- “API Documentation”
- “UX Writer”
- “Developer Educator”
- “Content Strategist (Technical)”
This is your digital handshake with the industry. It’s where people see your work without needing a meeting. You can host it in multiple ways depending on your technical skills and branding preferences.
Ideal for technical audiences and code-based documentation.
- Markdown-based
- Free hosting
- Custom domain support
- SEO-friendly
Tools: Jekyll, Docsify, Docusaurus
Perfect for writers who want to organize documentation visually.
- Drag and drop blocks
- Embeds and toggles
- Clean, distraction-free design
- No-code setup
Use Notion as a hub to link to external live examples (e.g., GitHub repos or blogs).
For full creative control.
- Custom UI/UX
- Control over performance and branding
- Can integrate blogs, forms, analytics
Tools: Webflow, Hugo, Gatsby, WordPress, TailwindCSS + Next.js