Complete AI Training
Sign inBecome a member

Your job's AI kit

Get your AI kit

Tell us who you are and what you do. We show you your kit right away and email you the link: skills, prompts, AI agents, MCP servers and courses for your job.

500+ jobs ready, and we make a kit for any other job. No payment needed to look.

Share

Skill · Granular Workflow Bundle

Api documentation

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

Agentic Awesome SkillsAdded Sep 5, 2026
IT & Software Development
Use it in my AI

How to use it

  1. Start your plan and connect your AI once
  2. Add the skill to your AI, one time only: press Copy skill and paste it into your AI's instructions: a project in ChatGPT, Claude or Grok, a Gem in Gemini, an agent in Microsoft 365 Copilot, or a rule in Cursor. It stays there for every new chat. In Kimi, paste it at the start of a new chat.
  3. Ask for the task in your own words, or say it directly:
Use the Api documentation skill to help me with this.
SKILL.md

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

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

More granular workflow bundle skills

All granular workflow bundle skills

Prompts that go with Api documentation

All prompts