API Documentation
Use when creating, editing, restructuring, or reviewing a service API document; keep operations, requests, responses, errors, types, routes, examples, and conventions precise and aligned with the authoritative contract.
Install
npx skills add sandbaseai/workbuddy-skill --skill api-documentationgit clone --depth 1 https://github.com/sandbaseai/workbuddy-skill.git /tmp/workbuddy-skill
mkdir -p ~/.claude/skills
cp -r /tmp/workbuddy-skill/skills/api-documentation ~/.claude/skills/api-documentationPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# API Documentation Use this skill when the deliverable is an API reference or contract document. This skill governs document form and clarity; route semantics, fields, authorization, status codes, and vocabulary remain owned by the repository's API contract, architecture records, and service implementation. Never invent a route or field to make a table look complete. ## Establish the source of truth Identify the API version, service/surface owner, transport, audience, canonical contract, supported environments, paired documents, and change scope. Read the existing document and authoritative schema/OpenAPI/implementation/tests before editing. Record whether a value is observed, specified, inferred, deprecated, or undecided. If sources conflict, report the conflict instead of silently choosing one. Keep each API document standalone enough to read. State transport, authentication, content type, common headers, type notation, optionality, success/error conventions, pagination, idempotency, and versioning once in a conventions section. Do not use a convention section to redefine business semantics owned elsewhere. ## Use a stable operation shape
Details
- Skill name
api-documentation- Repository
- sandbaseai/workbuddy-skill
- Path
skills/api-documentation/SKILL.md- License
- MIT
- Repo updated
- 8 September 2026
FAQ
What does the API Documentation skill do?
Use when creating, editing, restructuring, or reviewing a service API document; keep operations, requests, responses, errors, types, routes, examples, and conventions precise and aligned with the authoritative contract.
How do I install the API Documentation skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add sandbaseai/workbuddy-skill --skill api-documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is API Documentation popular?
It lives in sandbaseai/workbuddy-skill, which has 9 GitHub stars and 3 forks.
Related skills
Access Control Security Best Practices
9sandbaseai/workbuddy-skill
Design, review, implement, and verify least-privilege access controls across users, services, tenants, resources, and administrative workflows.
Accessibility Review
9sandbaseai/workbuddy-skill
Use when reviewing a web interface or interaction for semantic, keyboard, focus, screen-reader, ARIA, and contrast accessibility risks.
Acquire Codebase Knowledge
9sandbaseai/workbuddy-skill
Use when the user asks to map, document, or onboard into an existing codebase and needs evidence-backed architecture, structure, conventions, integrations, testing, and concerns documentation.
API Resilience Engineering
9sandbaseai/workbuddy-skill
Use when designing, implementing, reviewing, testing, or diagnosing API timeouts, retries, idempotency, rate limits, concurrency limits, circuit breakers, bulkheads, backpressure, load shedding, or ambiguous outcomes.
API Design Principles
9sandbaseai/workbuddy-skill
Use when designing, reviewing, documenting, versioning, or migrating REST or GraphQL APIs and their client, security, performance, and compatibility contracts.
Architectural Decision Record
9sandbaseai/workbuddy-skill
Use when documenting an important architecture or technology decision with context, constraints, alternatives, trade-offs, evidence, ownership, status, and a durable review path.
Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.