Skip to content

mateusoliveiradev1/frescari / .agents/skills/api-documentation

api-documentation

Verified

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

API Documentation Workflow

Overview

Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.

When to Use This Workflow

Use this workflow when:

  • Creating API documentation
  • Generating OpenAPI specs
  • Writing developer guides
  • Adding code examples
  • Setting up API portals

Workflow Phases

Phase 1: API Discovery

Skills to Invoke

  • api-documenter - API documentation
  • api-design-principles - API design

Actions

  1. Inventory endpoints
  2. Document request/response
  3. Identify authentication
  4. Map error codes
  5. Note rate limits

Copy-Paste Prompts

Use @api-documenter to discover and document API endpoints

Phase 2: OpenAPI Specification

Skills to Invoke

  • openapi-spec-generation - OpenAPI
  • api-documenter - API specs

Actions

  1. Create OpenAPI schema
  2. Define paths
  3. Add schemas
  4. Configure security
  5. Add examples

Copy-Paste Prompts

Use @openapi-spec-generation to create OpenAPI specification

Phase 3: Developer Guide

Skills to Invoke

  • api-documentation-generator - Documentation
  • documentation-templates - Templates

Actions

  1. Create getting started
  2. Write authentication guide
  3. Document common patterns
  4. Add troubleshooting
  5. Create FAQ

Copy-Paste Prompts

Use @api-documentation-generator to create developer guide

Phase 4: Code Examples

Skills to Invoke

  • api-documenter - Code examples
  • tutorial-engineer - Tutorials

Actions

  1. Create example requests
  2. Write SDK examples
  3. Add curl examples
  4. Create tutorials
  5. Test examples

Copy-Paste Prompts

Use @api-documenter to generate code examples

Phase 5: Interactive Docs

Skills to Invoke

  • api-documenter - Interactive docs

Actions

  1. Set up Swagger UI
  2. Configure Redoc
  3. Add try-it functionality
  4. Test interactivity
  5. Deploy docs

Copy-Paste Prompts

Use @api-documenter to set up interactive documentation

Phase 6: Documentation Site

Skills to Invoke

  • docs-architect - Documentation architecture
  • wiki-page-writer - Documentation

Actions

  1. Choose platform
  2. Design structure
  3. Create pages
  4. Add navigation
  5. Configure search

Copy-Paste Prompts

Use @docs-architect to design API documentation site

Phase 7: Maintenance

Skills to Invoke

  • api-documenter - Doc maintenance

Actions

  1. Set up auto-generation
  2. Configure validation
  3. Add review process
  4. Schedule updates
  5. Monitor feedback

Copy-Paste Prompts

Use @api-documenter to set up automated doc generation

Quality Gates

  • OpenAPI spec complete
  • Developer guide written
  • Code examples working
  • Interactive docs functional
  • Documentation deployed

Related Workflow Bundles

  • documentation - Documentation
  • api-development - API development
  • development - Development
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 465kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 196kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 196kUpdated Claude CodeCodexVerifiedInstall