New to Claude Skills? Learn how to install them →

Get Claude Skills
sickn33 on GitHub

API Documentation Workflow

Free

Streamline your API documentation process with ease.

by sickn3344.7k stars on sickn33/agentic-awesome-skills
1 views
Updated Aug 10, 2026
Get this skill

Free · Opens the source repo

What API Documentation Workflow does

The API Documentation Workflow skill is designed to help developers and technical writers create and maintain comprehensive API documentation efficiently. This workflow encompasses the entire process of API documentation, from generating OpenAPI specifications to writing developer guides and setting up interactive documentation. By following a structured approach, users can ensure that all aspects of their API are well-documented and easily accessible to developers.

The workflow is divided into several phases, each focusing on a specific aspect of API documentation. The first phase involves API discovery, where users can inventory endpoints, document request and response formats, and identify authentication methods. This foundational work sets the stage for generating OpenAPI specifications in the second phase, which includes defining paths, adding schemas, and configuring security settings.

In the subsequent phases, users can create developer guides that cover essential information such as getting started, authentication, and troubleshooting common issues. Additionally, the workflow facilitates the generation of code examples and interactive documentation, allowing developers to test API calls directly from the documentation. Finally, the workflow includes a maintenance phase to ensure that the documentation remains up-to-date and relevant, with features for auto-generation and validation.

This skill is particularly useful for teams working on APIs who need a systematic way to document their services. It helps ensure that documentation is not only comprehensive but also user-friendly, making it easier for developers to understand and integrate with the API.

When to use it

Use this workflow when you need to create or update API documentation, generate OpenAPI specs, or write developer guides.

When not to use it

This skill may not be suitable for projects that require extensive customization beyond the provided phases or for documentation that does not fit the API context.

What you can build with it

Creating API Documentation

Use this workflow to systematically document your API endpoints, including request/response formats and authentication methods.

Generating OpenAPI Specs

Leverage the skill to create OpenAPI specifications that define your API's structure and capabilities.

Maintaining Up-to-date Documentation

Set up automated processes to ensure your API documentation remains current and accurate as your API evolves.

How to install API Documentation Workflow

View source

1. Install with the skills CLI

npx skills add sickn33/agentic-awesome-skills/api-documentation --agent claude-code

2. Or install it manually

Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.

Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs

Inside SKILL.md

Written by sickn33

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.

Frequently asked questions about API Documentation Workflow

Similar skills

Markdown to HTML Conversion

Efficiently convert Markdown documents to HTML.

Code Tour

Create structured walkthroughs for codebases.

Acquire Codebase Knowledge

Streamline onboarding with comprehensive codebase documentation.

Documentation & Modernization

Streamline codebase documentation and modernization planning.

Azure Resource Visualizer

Generate architecture diagrams for Azure resources.

CLAUDE.md Improver

Optimize your CLAUDE.md files for better project context.