Write API documentation for our payments API
Project Deliverables & Description
Our payments has an OpenAPI file and some notes, but no real documentation, and customers keep asking the same setup questions. I need a quickstart, authentication guide, endpoint reference with examples in curl and two languages, error handling, and changelog format. I can give access to engineers for questions.
Support spends hours each week answering integration questions.
Key Deliverables:
- Outline & First Draft: Agreeing the structure with the team and delivering a first draft for review.
- Review Round & Final Document: Incorporating feedback, checking accuracy with the team, and delivering the final version.
Requirements:
- Demonstrated experience with Technical Writing, API Documentation, Markdown, OpenAPI
- Async communication preferred with milestone check-ins.
- Must match our existing brand voice and terminology.
Looking to get started promptly. Please submit a proposal detailing your relevant past experience and expected timeline.
Required Skills & Technologies
Contract Parameters
Budget Setup
$280 - $400
fixed Rate Structure
Experience Level
Intermediate
Target expertise level requested
Project Scope
Intermediate
Target project delivery scope
Contract Identifier: 371b7b12
Professional Trust Score
Client holds verified capital secured in project escrow holds.
Client Identity Verified
Corporate background confirmed
Escrow Lock Enforcement
Secure milestone hold verified
BotDigit Arbitrated
Arbitration protection active