api-documentation-writer

Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.

Jump to install

Repository: OneWave-AI/claude-skills
Last source activity: June 8, 2026 at 01:17
Detected SKILL.md language: English
Stars: 256
Forks: 42

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/OneWave-AI/claude-skills --skill api-documentation-writer

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

4 files

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

design-export-repair

Fixes broken decks/PDFs exported from Claude's "Design" feature (or similar AI deck generators) — cut-off or clipped text, wrong/substituted fonts, and corrupted .pptx package structure that shows up only once you export to PDF, not while looking at it in the app. Use this skill whenever the user uploads a zip, .pptx, or .pdf exported from Claude Design (or mentions "Design" export, an AI-generated deck, or a generated slide deck/PDF) AND reports it looking broken, wrong, cut off, garbled, or different from the original when opened, printed, or converted to PDF — even if they don't use the word "repair" or name the specific defect. Also trigger for general "my exported PDF/deck is broken, help fix it" requests when the file was clearly produced by an AI design/deck tool rather than hand-authored. Produces both a repaired, still-editable .pptx and a clean PDF, plus a report of exactly what was wrong and what changed.

2026-08-10

cash-flow-forecaster

Build a 13-week rolling cash flow forecast from bank exports, AR aging, AP bills, payroll, and recurring commitments -- the report that tells a small business whether it survives the quarter. Flags the crunch weeks early enough to act.

2026-07-15

commercial-lease-analyzer

Decode a commercial lease before signing or renewing -- true all-in occupancy cost (base rent plus NNN/CAM plus escalations), the clauses that hurt small tenants (personal guarantees, relocation, restoration), and the negotiation asks landlords routinely grant. The lease is most SMBs' biggest fixed cost and least-read document.

2026-07-15

View all from this repository

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

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.

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

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.

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.

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

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"