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.

9 stars 3 forksSoftware Development

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add sandbaseai/workbuddy-skill --skill api-documentation
Manual install
git 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-documentation

Personal 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
Read the full skill on GitHub

Details

Skill name
api-documentation
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

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.