26 Oct
|
Robert Half
|
Vancouver
26 Oct
Robert Half
Vancouver
We are recruiting on behalf of an established technology organization seeking an experienced Technical Writer to lead improvements to its technical and developer documentation.
Working closely with Product and Engineering teams, this individual will help translate complex product functionality into clear, practical resources that enable customers and developers to understand, configure, and integrate software solutions into their existing environments. The organization is looking for someone who can take ownership of the documentation process, establish best practices, and create a repeatable approach that can be applied across multiple products.
This remote contract prospect is open to candidates in British Columbia, Alberta, Manitoba, Ontario, and Quebec, and will run through to the end of January with potential to extend.
Key Responsibilities
- Develop and enhance technical documentation, including API references, SDK guides, integration tutorials, configuration instructions, and architecture diagrams.
- Partner with Product Managers and Software Engineers to understand product functionality, technical architecture, and integration requirements.
- Translate complex technical concepts into clear, customer-focused documentation that demonstrates how products and APIs address real-world business use cases.
- Create integration guides and architecture diagrams illustrating how technology solutions connect with customer environments.
- Review existing documentation, identify gaps, and establish a consistent structure and process for future content development.
- Work with API documentation platforms such as ReadMe, evaluating existing capabilities and recommending improvements where appropriate.
- Independently explore, test,
and validate product functionality using API playgrounds, testing environments, and other technical resources.
- Develop practical examples, including API requests and responses, JSON payloads, code snippets, and configuration scenarios.
- Support customer-facing technical documentation used throughout the sales, onboarding, and implementation processes.
- Establish documentation standards and workflows that can be replicated across additional products.
- Collaborate with technical stakeholders to ensure documentation remains accurate, accessible, and aligned with product development.
Required Qualifications
- 3–5+ years of experience in technical writing, developer documentation, or a related technical role.
- Strong experience documenting REST APIs, SDKs, software integrations, and technical architecture.
- Ability to understand and explain complex software functionality to both technical and non-technical audiences.
- Experience with API documentation platforms such as ReadMe, Swagger/OpenAPI, or similar tools.
- Working knowledge of JSON, XML, Markdown, API requests/responses, and software development concepts.
- Ability to independently test and explore APIs using tools such as Postman, API playgrounds, or similar environments.
- Experience developing technical architecture diagrams, integration workflows,
and customer-facing implementation guides.
- Strong understanding of how software products integrate within enterprise technology environments.
- Demonstrated ability to establish documentation processes, templates, and standards rather than solely maintaining existing content.
- Excellent written communication, organizational, and stakeholder management skills.
Nice-to-Have Qualifications
- Previous experience in software testing, quality assurance, solutions engineering, or technical implementation.
- Familiarity with JavaScript, Python, Java, C#, or other programming languages.
- Experience with Git-based documentation workflows and automated API documentation publishing.
- Background in SaaS, enterprise software, financial technology, or other API-driven environments.
- Experience supporting technical documentation used during enterprise sales cycles or customer onboarding.
- Experience evaluating and implementing documentation platforms or developer portals.
Why Consider This Opportunity? This is an opportunity to take ownership of a technical documentation initiative and make a measurable impact on how a technology organization communicates its products to customers and developers.
Rather than simply updating existing documentation, you will help establish the foundation for a more scalable and effective approach, working directly with technical stakeholders to define processes, improve the customer experience, and build reusable documentation frameworks.
The organization is seeking someone who can contribute immediately, work independently, and bring both technical curiosity and a strategic approach to documentation.
📌 Technical Writer (Vancouver)
🏢 Robert Half
📍 Vancouver