API Documentation Writer for SaaS Platform

Posted 5 days ago

Worldwide

Summary

One thing before you read on: if the work you deliver is copy pasted from an AI, we cancel the contract on the spot. We're hiring a person because we want a person's writing. We are rewriting our documentation from scratch and we want a person to write it. Not an AI. We tried that, it reads like it, and we don't want to publish it. What you'd write Roughly 45 pages on Mintlify, in five groups: Get started: introduction, quickstart, what every form needs, how our product works Frameworks and site builders: one page per platform (React, Next.js, Vue, Svelte, JavaScript, jQuery, Webflow, Framer, WordPress, Wix, Squarespace) Build with AI: connecting a form from Lovable, v0, Replit, Claude, ChatGPT, and using our MCP server from Claude, Codex, Cursor and Zapier Forms: one page per feature (notifications, auto response, thank you page, spam protection, file uploads, webhooks, integrations, retention and so on) Account and API: teams, plans and limits, API keys, then the API reference pages (authentication, errors, rate limits, pagination) You will not write code examples. They're done and tested. You write the sentences around them. What you'll get from us Our current docs. They're outdated in places but they cover the product and show what people ask about. A full AI written draft of the new docs, already structured and factually checked. Use it as a map of what each page has to cover. Don't reuse its prose. A carefully crafted, fully typed OpenAPI spec for the API reference. All code examples, a facts sheet with every limit and error code, and direct access to me (the founder) for any question about how the product behaves. The style we want Short declarative sentences. Instruction before explanation. Numbers instead of adjectives ("1 submission per 15 seconds per form", never "fast" or "reliable"). Every recommendation carries its reason. Every error says what to do next. If you like how Linear and Resend write their docs, you'll like this job. Who fits You've written developer documentation before and can show it. You can read an HTML form, a fetch call and an OpenAPI spec well enough to describe what they do, without needing to write them. You edit hard. Cutting a sentence is a skill we value more than adding one. English is a language you write in every day. How to apply Send two or three links to docs pages you wrote, and tell us in a paragraph what you'd change about one page of our current docs (ask for the link). If the paragraph reads like it was generated, we'll pass, so write it yourself. We'd rather pay for careful work than fast work.

  • $400.00

    Fixed-price
  • Intermediate
    Experience Level
  • Remote Job
  • Ongoing project
    Project Type
Skills and Expertise
English
Technical Writing
Activity on this job
  • Proposals:15 to 20
  • Last viewed by client:8 hours ago
  • Interviewing:
    5
  • Invites sent:
    5
  • Unanswered invites:
    4
About the client
Member since Apr 5, 2018
  • United States
    Wilmington12:15 AM
  • $630 total spent
    5 hires, 0 active

Explore similar jobs on Upwork

Wikipedia page creationHourly‐ Posted 2 weeks ago
English
Copywriting
Wikipedia
Writing
Copy Editing
Creative Writing
Web Developer for MedCap Flare ProjectsHourly‐ Posted 2 weeks ago
Web Development
HTML5
Web Design
PHP

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