Senior API Documentation Reviewer
Budget: $50.0
FIXED /
⭐ 0.00 (0)
BGR
api-development, restful, php, node.js
Föredragna kvalifikationer
- Talenttyp: Fristående
- Plats: United States, Canada, Australia, South Africa
- Erfarenhet: Medel
I am seeking a senior backend engineer or technical writer for a focused one-hour review of developer-facing API documentation.
The documentation covers a Go/Python backend service, including:
* Architecture and service responsibilities
* Authentication and environment configuration
* API requests and response examples
* Retry and failure-handling behavior
* Local setup and integration steps
* Operational assumptions and limitations
The documentation is technically complete, but I want an independent review to identify unclear language, missing assumptions, inconsistent terminology, and anything that could confuse an external developer.
I will provide the documentation before the call.
During the consultation, I would like you to review it from the perspective of an engineer integrating with the system for the first time and provide prioritized recommendations.
Required experience:
* Native-level English proficiency
* Backend or API engineering experience
* Strong developer documentation skills
* Ability to identify both technical and communication gaps
* Go or Python experience is preferred
Please include one example of technical documentation you have written or reviewed.
Öppna på Upwork
AI proposal draft
Generate a short cover letter for this job. Edit before sending.
Sign in to generate an AI proposal draft.
Logga in