API Documentation Architect
Generate complete, consistent API documentation from your codebase
What You Can Do
Claude systematically audits your API endpoints and generates comprehensive OpenAPI specifications, parameter documentation, error handling guides, and authentication flows. You get developer-ready documentation that ensures clarity, completeness, and consistency across all endpoints. The skill evaluates your existing documentation for gaps and suggests improvements to enhance developer experience.
Features
Automatically generate production-ready OpenAPI 3.0 specifications from your API code, including schemas, endpoints, methods, and request/response structures
Compare endpoints side-by-side to identify inconsistent naming conventions, response formats, error handling patterns, and parameter structures
Detect missing documentation elements like parameter descriptions, error codes, authentication requirements, rate limits, and example values
Create realistic, executable examples for each endpoint with sample payloads, headers, and responses to help developers integrate faster
Document required vs optional parameters, data types, validation rules, allowed values, and constraints for every endpoint
Systematically document all error responses, HTTP status codes, error messages, and recovery steps for each endpoint
Generate documentation for auth flows, required headers, API key formats, OAuth scopes, rate limits, and security best practices
Produce a structured audit report highlighting which endpoints lack descriptions, examples, or proper error documentation with actionable fixes
Example Output
Generated OpenAPI Spec (YAML excerpt):
post:
summary: Create user account
operationId: createUser
parameters:
- name: email
in: query
required: true
schema:
type: string
format: email
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name: {type: string, minLength: 1}
email: {type: string, format: email}
responses:
'201':
description: User created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Invalid email or missing required field
Consistency Audit Report:
- ✅ All POST endpoints use 201 status codes
- ⚠️ GET endpoints inconsistent: /users returns 200, /orders returns 200 (OK)
- ❌ Error responses: Some endpoints return error_code, others use code — standardize to error_code
Parameter Documentation Sample:
Parameter: api_key
Location: Header (X-API-Key)
Type: String
Required: Yes
Format: 32-character hex string
Example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
Description: Your unique API authentication key
What's Included
- OpenAPI Spec Generator: Transforms your API endpoints into standards-compliant OpenAPI 3.0 YAML/JSON specifications ready for tools like Swagger UI
- Endpoint Consistency Checker: Identifies naming inconsistencies, response format variations, error handling differences, and structural misalignments across your API
- Completeness Auditor: Scans all documentation and code for missing components: parameter descriptions, examples, error codes, auth requirements, rate limits
- Example Request/Response Templates: Pre-built markdown templates for documenting realistic API usage scenarios with proper headers, payloads, and response examples
- Documentation Standards Guide: Best practices for API documentation structure, naming conventions, error messaging, and developer clarity
Who It's For
- Backend Engineers
- API Developers
- Technical Documentation Writers
- Solutions Architects
- DevOps & Platform Engineers
Best For
- REST API documentation
- Microservice API auditing
- SDK and library documentation
- Internal API standardization
- Developer portal content generation
You might also like
You can create new Claude skills from scratch or improve existing ones by following proven structural patterns, frontmatter standards, and discoverability best practices. This skill teaches you how to write skills that future Claude instances can quickly locate, scan, and effectively apply to real problems—ensuring your techniques get reused instead of forgotten.
by pr-pm
Use Claude to generate comprehensive technical documentation for APIs, services, and libraries while enforcing consistency across hundreds of pages. You can audit existing docs against your style guide and best practices, then restructure the navigation for better developer discoverability. This skill transforms documentation from a maintenance burden into a scalable, developer-first asset that stays current as your product evolves.
You can synthesize complex financial data into multiple restructuring scenarios—standalone workouts, Chapter 11 plans, 363 asset sales, and liquidation analyses—while quantifying creditor recovery outcomes under each path. The skill generates professional disclosure statements, creditor information packages, and court-compliant financial exhibits that demonstrate your restructuring recommendations to judges, creditors, and management stakeholders with institutional rigor.
by bigshol
Discover what tools, workflows, specialist agents, and automation hooks are available in your workspace through interactive prompts and organized catalogs. Based on your goal—whether exploring codebases, fixing bugs, building features, or proving mathematical theorems—the skill surfaces the exact capabilities you need.
by parcadei
You can systematically discover Claude Code skills and MCP servers tailored to your specific workflow without building from scratch. Resource Scout searches multiple authoritative sources including SkillsMP, SkillHub.club, Claude Skills Hub, and GitHub repositories to find tools that solve your problem. Whether you need skills for a specific domain, MCP servers to connect external tools, or want to verify a solution doesn't already exist, this skill provides a structured discovery process.
by nicepkg
Turn raw customer research data—interviews, surveys, support tickets, feature requests—into organized, prioritized insights that drive product decisions. This skill identifies recurring themes across enterprise feedback, extracts actionable recommendations, and maps findings to your roadmap strategy, helping you make evidence-based product choices.
by bigshol
Create clear, hierarchical metric frameworks that cascade from strategic goals to tactical KPIs. You'll validate metric definitions against best practices, assign ownership, and generate stakeholder communication plans. The result is a shared language for success across your organization.
by bigshol
You can build enterprise valuation models grounded in operational drivers rather than arbitrary growth assumptions. This skill guides you through documenting explicit assumptions, projecting cash flows tied to historical performance, calculating WACC, determining terminal value, and performing sensitivity and scenario analysis to quantify defensible valuation ranges. Your models will be audit-ready and capable of withstanding client questioning and legal challenge.
by bigshol