Skip to content
Get packs

API Documentation Workflow

Guides an agent through planning OpenAPI specs, developer guides, code examples and doc sites

Source Download skill
Repository
sickn33/agentic-awesome-skills
Stars
49,023
Licence
MIT
Files
1 file

What it does

This is an index-style workflow that tells an AI agent how to produce API documentation in seven phases: discover endpoints, write an OpenAPI spec, draft a developer guide, add code examples, set up interactive docs, build a documentation site, and maintain it. It names other skills to call in each phase and provides copy-paste prompts. It also asks the agent to keep secrets out of examples, use sandbox endpoints for try-it features, and preview docs locally before any publishing or deployment.

Great for

  • Developers writing or updating documentation for an existing REST API
  • Teams that want a checklist-style plan for spec, guide and interactive docs
  • Technical writers who want an agent to draft OpenAPI and guide content from the real implementation

Skip it if

  • Anyone expecting it to publish or deploy docs automatically; the file says deployment needs separate authorization and it is not performed by this skill alone
  • Projects where the referenced helper skills (api-documenter, openapi-spec-generation, etc.) are not installed, since the workflow only names them and their behaviour is not defined in this file
  • Use with unverified APIs: generated examples and specs must be checked against the real system before release

Try asking

  • “Use @api-documenter to discover and document the endpoints in this Express project”
  • “Create an OpenAPI 3 specification for the orders API based on the route handlers”
  • “Draft a getting-started and authentication guide for our developer portal”
  • “Set up a local Swagger UI preview of the spec with sandbox try-it examples”
Step-by-step guide: how to use API Documentation WorkflowInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    api-documentation.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip api-documentation.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip api-documentation.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Point the agent at the real implementation or existing spec so the contract is grounded, not invented
  • Use sandbox endpoints and test credentials for any try-it examples, and review generated examples for leaked secrets
  • Ask for a local preview first and approve publishing or deployment separately

What's inside

  • SKILL.md

Redistributed unmodified from sickn33/agentic-awesome-skills under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.