api-documentation-writer

Installation
SKILL.md

API Documentation Writer Skill

Overview

This skill helps you create clear, comprehensive API documentation that developers love. Covers OpenAPI/Swagger specifications, endpoint references, authentication guides, code examples in multiple languages, and developer experience best practices.

Documentation Philosophy

The Three C's

  1. Clear: Unambiguous, jargon-free explanations
  2. Complete: All parameters, responses, and edge cases documented
  3. Current: Always in sync with the actual API behavior

What to Document

  • DO: Document every public endpoint
  • DO: Include request/response examples for all scenarios
  • DO: Document error codes with remediation steps
  • DO: Provide code examples in popular languages
  • DON'T: Document internal/private endpoints
Related skills
Installs
50
First Seen
Jan 22, 2026