Job Description

Job Title: Technical Writer - API

Location: Canada - Remote

Experience: 5 to 10 Years

Role Summary: We are hiring for this role where the selected candidate will help transform and standardize internal API documentation into a scalable knowledge base. You'll work with engineering and DevRel teams to ensure clarity, consistency, and accessibility across REST and GraphQL documentation .

Key Responsibilities

• Audit and consolidate existing technical documentation for REST and GraphQL APIs
• Migrate validated content into a newly structured Confluence knowledge base
• Work with subject matter experts to resolve documentation conflicts and define the source of truth
• Use GPT tools (e.g., ChatGPT) to rewrite and enhance documentation clarity and consistency
• Build and apply templates for API overviews, usage guides, integration patterns, and policies
• Identify documentation gaps and coordinate with engineering teams to address them
• Maintain ongoing collaboration with project leads to ensure progress and alignment

Must-Have Skills

• At least 5+ years of experience in technical writing or API content strategy
• Strong understanding of REST and GraphQL APIs
• Hands-on experience using GPT tools for content rewriting or generation
• Proficiency with Confluence and GitHub documentation workflows
• Excellent editorial skills and attention to detail
• Ability to work independently with regular check-ins

Nice-to-Have Skills

• Familiarity with OpenAPI/Stoplight specifications
• Experience supporting internal engineering or platform integration teams
• Understanding of the developer onboarding and self-service documentation needs
• Comfort working in distributed, asynchronous teams
• Exposure to Slack bot integrations or Slack-based automation

Interested in this opportunity? Apply now , and our recruitment team will review your profile and reach out if it aligns with client requirements.
We value every application and aim to respond to those closely matching the role criteria. Even if you don't hear back this time, we encourage you to stay connected with us for future opportunities.

About Techedin Techedin is a global IT staffing and technology services firm helping enterprises build high-performance tech teams. We support innovation at scale by connecting skilled professionals to leading companies and impactful projects. We prioritize transparency, responsiveness, and the right fit.

Diversity & Inclusion At Techedin, we welcome applicants of all backgrounds, communities, and experiences. Our commitment to diversity, equity, and inclusion drives us to create hiring experiences that are open, fair, and human-first.

Job Tags

Similar Jobs