Individual skill
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.
api-documentation-writer/SKILL.md
Source commit b2267d9171af4f56848d82992381b20b89b44056
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Network or broad shell
- Last checked
- Nov 10, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 425
- Repository last updated
- Oct 20, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- agent-skills Repository topic
- ai-agents Repository topic
- anthropic Repository topic
- claude Repository topic
- claude-code Repository topic
- claude-skills Repository topic
- developer-tools Repository topic
- llm Repository topic
- prompt-engineering Repository topic
- sales-automation Repository topic
- docs Derived category
- engineering Derived category
- security Derived category
- docs-api Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 2,168 bytesreferences/best-practices.mddoc · 1,342 bytesreferences/documentation-structure.mddoc · 1,390 bytesreferences/output-template.mddoc · 3,214 bytes
Read excerpt
# 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.