$1,800.00 Fixed
We're a project management SaaS platform serving 8,000 users, and our documentation is outdated and incomplete, causing support tickets and user frustration. We need an experienced Technical Writer to create comprehensive, user-friendly documentation covering our entire product—including getting started guides, feature tutorials, API reference documentation, troubleshooting sections, and admin guides. Your writing should make complex features accessible to non-technical users while providing detailed technical specifications for developers integrating our API.
You'll work closely with our product and engineering teams to understand features deeply, test workflows yourself to document accurately, create step-by-step tutorials with screenshots, write clear API endpoint descriptions with code examples, and organize content logically so users can find answers quickly. The documentation will live in our help center (built on Intercom or similar platform) and needs to be searchable, scannable, and written in clear, concise language that matches our friendly brand voice.
This is a 4-5 week project with deliverables including 50-80 pages of documentation across multiple categories. We're looking for a technical writer with SaaS experience, ability to understand software features quickly, strong information architecture skills, and portfolio showing clear, well-organized documentation. You'll receive product access, engineering support for technical questions, and existing documentation to improve. If you've written documentation that measurably reduced support tickets, we want to hear about it.
Key Responsibilities
Audit existing documentation and identify gaps
Test product features to understand functionality deeply
Write getting started guide for new users (10-15 pages)
Create feature-specific tutorials with step-by-step instructions
Document admin settings and configuration options
Write API reference documentation with endpoint descriptions
Create code examples in multiple programming languages
Develop troubleshooting guides for common issues
Take and annotate screenshots for visual guidance
Organize content with logical information architecture
Write in clear, concise language for non-technical audiences
Ensure consistency in terminology and formatting
Implement SEO best practices for searchability
Required Skills
Technical Writing
SaaS Documentation
API Documentation
User Guide Writing
Tutorial Creation
Information Architecture
Technical Communication
Software Documentation
Markdown
Content Organization
Screenshot Annotation
Developer Documentation
Tools
Google Docs or Microsoft Word (drafting)
Markdown (for formatting)
Screen capture tools (Snagit, CloudApp)
Image annotation tools (Skitch, Markup)
Help center platform (Intercom, Zendesk, ReadMe)
Product access for testing
Postman (API testing and documentation)
Git/GitHub (version control, optional)
Slack (team communication)
Zoom (product walkthroughs)
Deliverables
Getting Started Guide (10-15 pages)
Feature tutorials for 15-20 major features
Admin configuration guide
API reference documentation (20-30 endpoints)
Code examples in 3+ programming languages
Troubleshooting guide with common issues
FAQ section (30-40 questions)
Glossary of product terminology
Navigation structure and content organization
100+ annotated screenshots
All content formatted in Markdown
Style guide for future documentation
50-80 pages total documentation
2 weeks post-delivery support for revisions
- Proposal: 0
- Less than 2 month
