Technical Writer

CVAT.ai; United States; Remote; USD 90,000 - 130,000; Full time

Benefits offered by this job

Remote work

Medical insurance

Career development

Open-source project

Job summary

CVAT.ai is seeking a technical writer to make our computer vision product documentation useful, accurate, and easy to navigate for users and developers. You will maintain guides and API references, collaborate with engineers to improve workflows, and leverage analytics to identify gaps.

You will publish runnable API examples using cURL, Postman, Bash, and Python, review API usability with the team, and triage documentation issues to support our AI chatbot and open-source contributions.

Qualifications

• Portfolio showing SDK, CLI, or API documentation for developer products.
• Hands-on familiarity with OpenAPI or related API documentation tools such as Swagger, Redoc, Stoplight, or Swagger UI.
• Ability to produce clear, practical developer documentation and runnable examples.

Responsibilities

• Maintain user and developer guides, SDK and API references, and release notes.
• Keep documentation organized and searchable, including OpenAPI-based API references and CLI guidance.
• Provide runnable examples for APIs, command-line tools, and Python SDKs using formats such as cURL, Postman, Bash, and Python.
• Review API, SDK, and CLI usability with engineers and suggest improvements.
• Use documentation analytics to find gaps and track search success and task completion.
• Triage community documentation issues, publish tutorials, and support an AI chatbot for common questions.

Skills

OpenAPI familiarity

Runnable code examples

API documentation

CLI guidance

Tools

Swagger UI

Swagger

Redoc

Stoplight

Job description

Role overview

Make technical documentation useful, accurate, and easy to navigate for users and developers of a computer vision product. You’ll maintain guides and API references, work with engineers to improve developer workflows, and use reader feedback and documentation analytics to identify gaps.

Responsibilities

• Maintain user and developer guides, SDK and API references, and release notes.


• Keep documentation organized and searchable, including OpenAPI-based API references and CLI guidance.


• Provide runnable examples for APIs, command-line tools, and Python SDKs using formats such as cURL, Postman, Bash, and Python.


• Review API, SDK, and CLI usability with engineers and suggest improvements.


• Use documentation analytics to find gaps and track search success and task completion.


• Triage community documentation issues, publish tutorials, and support an AI chatbot for common questions.

Requirements

• A portfolio showing SDK, CLI, or API documentation for developer products.


• Hands‑on familiarity with OpenAPI or related API documentation tools such as Swagger, Redoc, Stoplight, or Swagger UI.


• Ability to produce clear, practical developer documentation and runnable examples.

Nice to have

• Experience using AI to speed up documentation work, generate code examples, or flag outdated content.


• Experience contributing to open-source documentation or supporting a documentation chatbot.

Benefits and work setup

• Full-time, remote worldwide or from Cyprus.


• Remote-first flexibility, medical insurance, and time off.


• Opportunity for ownership, career development, and work on an open-source project.