API Documentation Patterns
CommunityWrite better API docs
Software Engineering#best practices#openapi#specification#technical writing#developer experience#api documentation
AuthorHermeticOrmus
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides best practices and anti-patterns for documenting APIs, ensuring clarity, usability, and maintainability for developers consuming your API.
Core Features & Use Cases
- Standardized Documentation: Learn how to document parameters, request bodies, responses, and schemas effectively.
- Improve Discoverability: Understand the difference between
summaryanddescriptionfor better navigation. - Use Case: A developer is writing an OpenAPI specification for a new microservice and needs to ensure their documentation is clear, comprehensive, and follows industry best practices. They consult this Skill for guidance on structuring their YAML.
Quick Start
Review the API Documentation Patterns skill to learn how to document API parameters effectively.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: API Documentation Patterns Download link: https://github.com/HermeticOrmus/LibreCopy-Claude-Code/archive/main.zip#api-documentation-patterns Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.