API Technical Writer Needed for SaaS Developer Documentation (Swagger/OpenAPI)

We are a cloud-based inventory management platform launching our first public API to allow third-party integrations. Our engineering team has built a robust RESTful API, but our current documentation is sparse and auto-generated, making it difficult for external developers to understand how to authenticate and consume our endpoints effectively. We need a skilled Technical Writer with a background in software development or API documentation to bridge this gap.

You will work directly with our Lead Backend Engineer and Product Manager to understand the API's functionality. Your primary task will be to transform our raw Swagger/OpenAPI definitions into a comprehensive, user-friendly developer portal. This involves writing clear "Getting Started" guides, authentication tutorials (OAuth 2.0), and detailed endpoint references with request/response examples. You must be able to test the API endpoints yourself using Postman to ensure accuracy.

We believe that great documentation is a product in itself. We are looking for someone who can write in a tone that is professional yet accessible, avoiding unnecessary jargon while being technically precise. If you have experience using documentation platforms like GitBook or ReadMe.com, please highlight that in your proposal.

Key Responsibilities

Audit existing internal API documentation and auto-generated Swagger files for accuracy.

Write a comprehensive "Getting Started" guide including Authentication, Rate Limiting, and Pagination details.

Create code samples in Python, JavaScript (Node.js), and Curl for common use cases.

Organize and structure the documentation on our public developer portal (GitBook).

Test API endpoints using Postman to verify that the documentation matches the actual behavior.

Collaborate with developers to document error codes and troubleshooting steps.

Required Skills

Technical Writing

API Documentation

RESTful APIs

Markdown

Software Documentation

English Grammar & Editing

Tools

Postman (for API testing)

Swagger / OpenAPI Specification

Git / GitHub

GitBook or ReadMe.com

VS Code

Deliverables

Documentation Strategy: A brief outline of the proposed structure for the developer portal.

API Reference Guide: Fully polished documentation for all 25+ endpoints.

Quick Start Tutorial: A step-by-step guide for a "Hello World" integration.

Code Snippets: Verified code examples for 3 major languages.

Review Report: A list of any bugs or inconsistencies found in the API during the writing process.