api-documentationlisted
Install: claude install-skill sandbaseai/workbuddy-skill
# 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
Organize operations under one operations section. Give every operation a stable, backtick-wrapped route heading, a human-readable purpose/authority description, and explicit `Request`, `Response`, and `Errors` sections. Include caller, authorization, asynchronous behavior, idempotency, integrity gates, and workflow references in the