API Technical Writer

Posted yesterday

Only freelancers located in the U.S. may apply.U.S. located freelancers only

Summary

We're looking for an 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.

  • More than 30 hrs/week
    Hourly
  • 6+ months
    Duration
  • Intermediate
    Experience Level
  • $40.00

    -

    $60.00

    Hourly
  • Remote Job
  • Ongoing project
    Project Type
Skills and Expertise
Mandatory skills
API Documentation
OpenAPI
Activity on this job
  • Proposals:20 to 50
  • Last viewed by client:yesterday
  • Interviewing:
    0
  • Invites sent:
    1
  • Unanswered invites:
    1
About the client
Member since May 28, 2021
  • United States
    Renton1:21 AM
  • $849K total spent
    28 hires, 11 active
  • 12,351 hours
  • Tech & IT
    Large company (100-1,000 people)

Explore similar jobs on Upwork

ISO Tank Management Software DeveloperHourly‐ Posted 2 weeks ago
Technical Writing
Agile Software Development
Management Skills
Content Writing
English
Nutrition
Content Writing
Blog Content
Writing
Article
Dietetics

How it works

  • Post a job icon
    Create your free profile
    Highlight your skills and experience, show your portfolio, and set your ideal pay rate.
  • Talent comes to you icon
    Work the way you want
    Apply for jobs, create easy-to-by projects, or access exclusive opportunities that come to you.
  • Payment simplified icon
    Get paid securely
    From contract to payment, we help you work safely and get paid securely.
Want to get started? Create a profile

About Upwork

  • Rating is 4.9 out of 5.
    4.9/5
    (Average rating of clients by professionals)
  • G2 2021
    #1 freelance platform
  • 49,000+
    Signed contract every week
  • $2.3B
    Freelancers earned on Upwork in 2020

Find the best freelance jobs

Growing your career is as easy as creating a free profile and finding work like this that fits your skills.

Trusted by

  • Microsoft Logo
  • Airbnb Logo
  • Bissell Logo
  • GoDaddy Logo