Technical Writer to Document Our Public API

Posted 4 days ago

Worldwide

Summary

We run a live SaaS platform with thousands of active users, and we are building out our public developer API. We need clear, developer-facing API documentation to show developers and technical buyers is suitable for every third-party integration, plugin, or partner build. You will document our API so a developer can get from zero to their first successful call on their own. That includes authentication, endpoints, request and response formats, parameters, error handling, and real usage examples with working code. What we are looking for: • Any experience writing API documentation for a developer audience • Ability to work from our API spec or directly with our engineers and turn it into clear, structured docs • Familiarity with REST APIs, authentication flows such as OAuth and API keys, and JSON • Precise, well-organized writing that is genuinely easy to follow Nice to have: • Experience writing blogs or guides on API integration • Developer quickstart guides, SDK documentation, or docs-as-code workflows I am not looking for an expert writer. I am looking for someone who is genuinely good at explaining complex technical concepts clearly to developers and technical readers. To be considered, please answer all the screening questions. Applications that skip them will not be reviewed. THIS IS ONE TIME PROJECT

  • Less than 30 hrs/week
    Hourly
  • 1-3 months
    Duration
  • Intermediate
    Experience Level
  • $15.00

    -

    $40.00

    Hourly
  • Remote Job
  • Ongoing project
    Project Type
Skills and Expertise
Mandatory skills
API Documentation
Technical Writing
Activity on this job
  • Proposals:5 to 10
  • Last viewed by client:3 days ago
  • Hires:
    1
  • Interviewing:
    0
  • Invites sent:
    0
  • Unanswered invites:
    0
About the client
Member since Apr 18, 2025
  • Pakistan
    Rawalpindi9:56 PM
  • 1 hire, 1 active

Explore similar jobs on Upwork

French
German
Technical Writing
Content Writing
Article Writing
Writing
Instruction Manual
Blog Writing
Technical Documentation
English
Dicom viewer crashing on MPR volume loadingFixed-price‐ Posted 2 months ago
Medical Records Research
Medical Transcription
Artificial Intelligence
DICOM
Science & Medical Translation
Medical Terminology
Mediclinic
Medical Editing
Medical Imaging
Scientific Research
Telemedicine

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