Remote job
Technical Writer
Job details
About this role
Role overview Create and maintain documentation that helps developers, customers, and business stakeholders understand software products and use their features effectively. The work covers product guides, API references, learning materials, and the structure and upkeep of an external documentation portal.
Responsibilities - Write and update product guides, feature documentation, release notes, and supporting help content. - Produce API references covering endpoints, requests and responses, authentication, errors, and usage scenarios. - Work with engineers to verify technical accuracy and keep API materials aligned with product changes. - Create onboarding instructions, tutorials, FAQs, troubleshooting articles, and educational content. - Organize and maintain a public documentation site, including versioning and ways for readers to provide feedback. - Partner with product, engineering, support, and marketing teams to gather information and improve coverage.
Requirements - At least two years of technical writing experience for SaaS products or developer platforms. - Strong experience documenting REST APIs and using OpenAPI or Swagger-related tools. - Practical experience with docs-as-code workflows using Markdown, Git, and static site generators. - Ability to explain technical concepts clearly to developers, end users, and business audiences. - Strong organization and attention to detail, with the ability to manage several documentation projects.
Nice to have - Experience creating diagrams, screenshots, or flowcharts. - Familiarity with AI or machine learning platforms, developer tools, documentation platforms, and project tracking software.
Benefits and work setup - Remote role open across global time zones.