NRemote (Canada) / Hybrid VancouverTechnical Writer, API Documentation
Context
A software company wants clearer developer and customer documentation so customers can integrate its solutions into their environments. The contract runs through the end of January, with possible extension, at 40 hours per week, starting as soon as possible.
What you'll do
- Develop and improve API references, SDK guides, integration tutorials and configuration instructions
- Create technical architecture diagrams and integration workflows
- Test and validate APIs with Postman and similar tools, and write practical examples such as requests, responses and JSON payloads
- Review existing documentation, identify gaps and establish documentation standards and repeatable workflows
- Support customer onboarding, implementation and enterprise sales documentation
Profile
- 4+ years of technical writing, developer documentation or a related technical role
- Strong experience documenting REST APIs, SDKs, software integrations and technical architecture
- Experience with ReadMe, Swagger/OpenAPI or similar documentation platforms
- Working knowledge of JSON, XML, Markdown and software development concepts
- Hands-on API testing experience with Postman or similar tools