akillness avatar

Api Documentation

You need developer docs for an API that already exists, not design work or internal specs. This skill writes OpenAPI reference pages, quickstarts, webhook guides, SDK docs, and integration task guides for external or internal developers actually trying to use your endpoints. It stays opinionated about boundaries: if you're designing the contract, that's a different skill. If you're writing release notes or end-user help, also different. The source is detailed and well-structured, with clear routing rules, truthful example requirements, and practical packet choices for REST, GraphQL, webhooks, and SDKs. It aggressively separates "helping integrators succeed" from contract design, which is the right call for maintainable developer portals.

skills.sh installs
174
GitHub stars
22
last updated
Jun 3, 2026

Install

$ npx -y skills add akillness/oh-my-skills --skill api-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

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:

Sponsors

Details

Repository
github.com/akillness/oh-my-skills
Categories
Backend & APIs, Documentation
First seen
Jun 3, 2026

More from akillness/oh-my-skills

All 81
1akillness avatardatabase-schema-designakillness/oh-my-skillsdatabase schema design172skills.sh installs
2wimolivier avatarpostgresql-best-practiceswimolivier/postgresql-best-practicespostgresql best practices172skills.sh installs
3akillness avatarauthentication-setupakillness/oh-my-skillsauthentication setup168skills.sh installs
4akillness avatarfirebase-ai-logicakillness/oh-my-skillsfirebase ai logic168skills.sh installs
5akillness avatarfirebase-cliakillness/oh-my-skillsfirebase cli164skills.sh installs
6absolutelyskilled avatarapi-designabsolutelyskilled/absolutelyskilledapi design162skills.sh installs