api-documentation

name	api-documentation
description	Publish or refresh developer-facing API documentation for REST, GraphQL, webhook, SDK, and developer-portal surfaces: reference docs, quickstarts, task guides, auth/setup notes for API consumers, truthful example requests, error/retry/limit guidance, and migration updates. Use when the contract already exists and the main job is helping integrators succeed with the API, not designing resources or versioning strategy. Triggers on: API docs, developer portal, OpenAPI reference, SDK docs, webhook docs, quickstart, integration guide, endpoint reference, pagination docs, rate-limit docs, migration note, and partner API guide. Route contract design to `api-design`, internal specs/runbooks to `technical-writing`, end-user UI help to `user-guide-writing`, auth implementation to `authentication-setup`, and release-note hygiene to `changelog-maintenance`.
allowed-tools	Read Write Edit Glob Grep
compatibility	Best for docs-as-code repos, developer portals, OpenAPI/GraphQL references, SDK docs, and integration guides where the output helps external or internal integrators use an API safely and successfully.
license	MIT
metadata	{"tags":"api-documentation, developer-docs, openapi, swagger, graphql, webhooks, sdk-docs, developer-portal, integration-guides","platforms":"Claude, ChatGPT, Gemini","version":"2.1.0","modernization":"2026-04-13T00:00:00.000Z","structural_hardening":"2026-04-17T00:00:00.000Z"}

API Documentation

Use this skill when the main job is publishing or refreshing developer-facing API docs that help integrators reach first success, understand reference truth, and stay unblocked as the API evolves.

api-documentation is the documentation-cluster anchor for:

• endpoint / schema reference docs
• quickstarts and first-success flows
• task-oriented integration guides
• SDK guides
• webhook delivery / verification docs
• developer-portal navigation and grouped reference surfaces
• migration updates attached to the docs surface

Read these support docs before choosing the mode or output packet:

• references/documentation-modes-and-boundaries.md
• references/output-packets-and-navigation.md
• references/example-and-reference-checklist.md
• references/publishing-and-drift-control.md

When to use this skill

• A team needs API reference, quickstarts, or portal pages that external developers, partners, or internal integrators can actually use.
• An OpenAPI or schema artifact already exists, but the docs need structure, examples, auth/setup guidance, error handling, or clearer navigation.
• Existing API docs drifted after auth, versioning, retry, pagination, webhook, or SDK changes.
• A public, partner, or internal API launch needs developer-facing guides, migration notes, or trustworthy examples.
• A large API surface needs grouping, selective publishing, or cleaner portal structure instead of one giant reference dump.

When not to use this skill

• The main job is designing resources, endpoint shape, schema rules, or versioning strategy → use api-design.
• The main job is writing internal specs, ADRs, runbooks, rollout docs, or system migration procedures → use technical-writing.
• The main job is end-user/product UI onboarding, screenshots, tutorials, or help-center docs → use user-guide-writing.
• The main job is implementing auth/session/provider behavior rather than documenting how API consumers authenticate → use authentication-setup.
• The main job is release-note, semver, or changelog hygiene → use .