Write API documentation with examples and error codes. TRIGGERS - Use when user needs help with api-documentation related tasks.
Scanned 9/11/2026
Install to Claude Code
Skills Directorynpx -y skills add lionelsimai/claude-skills-collection --skill api-documentation --agent claude-codeInstalls into .claude/skills of the current project.
Are you the author of Api Documentation?
Add the live security badge to your README — it updates automatically with every re-scan.
[](https://www.skillsdirectory.com/skills/lionelsimai-api-documentation)More formats (shields.io, HTML) on the badges page.
---
name: api-documentation
description: |
Write API documentation with examples and error codes.
TRIGGERS - Use when user needs help with api-documentation related tasks.
category: Development
version: 1.0
---
# api-documentation
## Workflow
1. **Understand Requirements** - Context, audience, goals, constraints
2. **Research & Analyze** - Best practices, frameworks, background
3. **Create Draft** - Structured, actionable, tailored output
4. **Review & Refine** - Quality check, consistency, completeness
## Output Format
**Context:** [Situation] | **Objective:** [Goal] | **Audience:** [Who]
### Key Components
| Component | Details | Owner | Timeline |
|-----------|---------|-------|----------|
| [Item] | [Specifics] | [Who] | [When] |
### Action Plan
1. **Immediate:** [First steps]
2. **Short-term:** [Build momentum]
3. **Medium-term:** [Scale]
### Success Metrics
| Metric | Target | Method |
|--------|--------|--------|
| [KPI] | [Goal] | [Track] |
## Quality Checklist
- [ ] Tailored to context
- [ ] Actionable steps
- [ ] Measurable criteria
- [ ] Professional format
Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.
No comments yet. Be the first to comment!
