mcpField
A
api-documentation-writer

api-documentation-writer

github.com/onewave-aiDevelopment393373 installsUpdated 1w ago
Repository

About api-documentation-writer

A skill for creating comprehensive, developer-oriented API documentation. It guides authors through API details, examples, errors, limits, and quality checks across REST, GraphQL, and other API types.

Key features

  1. 01API information gathering
  2. 02Structured documentation sections
  3. 03REST and GraphQL examples
  4. 04Error and rate-limit guidance
  5. 05curl, JavaScript, and Python samples
  6. 06Documentation quality checklist

Use cases

  1. 01Document REST endpoints
  2. 02Create an OpenAPI specification
  3. 03Explain a GraphQL schema
  4. 04Write webhook or authentication guides

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/onewave-ai/claude-skills --skill api-documentation-writer

After installing, type/api-documentation-writerin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
best-practices.md
documentation-structure.md
output-template.md

Details

From the project README

API Documentation Writer

Generate comprehensive, developer-friendly API documentation.

Contents

  • references/documentation-structure.md — every section to cover (overview, auth, endpoints, errors, rate limits, SDKs, webhooks, GraphQL)
  • references/output-template.md — canonical REST Markdown template with worked examples
  • references/best-practices.md — best practices, developer-experience tips, and the output quality checklist

Workflow

  1. Gather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and versioning strategy, available endpoints and their purposes, request/response formats, and any rate limiting or usage restrictions.

  2. Build the documentation structure. Cover every section in references/documentation-structure.md, ordering the most common operations first.

  3. Generate the output. Follow references/output-template.md for REST APIs; adapt to schema, query, mutation, and subscription examples for GraphQL. Replace all placeholders with realistic example data and show both request and response.

  4. Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers to check, and how to handle 429 responses.

  5. Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available.

  6. Verify quality against the checklist in references/best-practices.md before delivering.

Example Triggers

  • "Write API documentation for my REST endpoints"
  • "Create OpenAPI spec for my API"
  • "Document this GraphQL schema"
  • "Generate developer docs for my webhook API"
  • "Write authentication guide for API"

Comments

Markdown supported