API Technical Writer
Budżet: $40.0 - $55.0
HOURLY / FULL_TIME
⭐ 0.00 (0)
United States
english, api-development, javascript, github, markdown, json
We're looking for a API Technical Writer to create and maintain developer-facing documentation for our API products in a healthcare/SaaS environment. This role partners closely with Product and Engineering to produce API documentation, release notes, and customer-facing content for minor and major releases. The ideal candidate has real development experience, is comfortable working inside engineering workflows (not just editing docs after the fact), and can champion a document-first approach to API development.
What You’ll Do
• Create and maintain API documentation and customer-facing release notes for minor and major product releases in partnership with Product and Engineering teams.
• Apply OpenAPI Specification (OAS 3.0) standards and champion a documentation-first approach, ensuring API contracts are clearly defined and aligned before development begins.
• Write and maintain documentation in Markdown using Git-based workflows and participate in GitHub release and publishing processes.
• Test and interact directly with REST APIs to validate functionality and create accurate examples and documentation (e.g., curl).
• Explore opportunities to leverage AI and automation to improve documentation quality, maintenance, and API change tracking.
• Independently gather information through hands-on experimentation and collaboration with subject matter experts to create technical documentation and process guides.
• Maintain and organize technical reference materials, research, design specifications, and other documentation assets.
• Continuously evaluate and improve documentation, partnering with Customer Success, Support, and customers to identify content gaps and enhance the developer experience.
What You’ll Bring
• Experience creating and maintaining developer-facing API documentation.
• Working knowledge of the OpenAPI Specification (OAS 3.0) and API contract-based development practices.
• Experience working in GitHub, including pull requests, branching strategies, and release/publishing workflows.
• Strong Markdown writing skills and experience with Git-based documentation platforms.
• Ability to call, test, and experiment with REST APIs and document JSON request/response payloads.
• Experience creating API examples using curl; experience with JavaScript, Java, PHP, or similar languages is a plus.
• Strong technical writing skills with the ability to translate complex product and engineering concepts into clear, accurate, and user-friendly documentation.
• Demonstrated ability to independently learn technical systems and drive documentation efforts with minimal oversight.
• Ability to thrive in a fast-paced, collaborative SaaS environment.
Preferred Qualifications
• Prior experience in healthcare and SaaS environments.
• Familiarity with healthcare data and interoperability concepts, including PHI handling, patient identifiers, NPIs, and clinical workflow terminology.
• Experience documenting integrations with EMR/EHR platforms such as Epic.
• Ability to read and understand production code, API implementations, and system integrations.
• Hands-on software development experience writing or maintaining production applications, APIs, or integration solutions.
• Familiarity with TypeScript and/or JavaScript.
• Experience serving in a hybrid Technical Writer, Documentation Engineer, or Developer Documentation role.
• Interest in AI-assisted documentation workflows, content automation, or API change-tracking solutions.
Otwórz na Upwork