api-docs-writing
Update or create API documentation after making changes to the public interface of an API. Use when modifying existing endpoints, introducing new endpoints, or when API implementation changes are complete and tested.
Best use case
api-docs-writing is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Update or create API documentation after making changes to the public interface of an API. Use when modifying existing endpoints, introducing new endpoints, or when API implementation changes are complete and tested.
Teams using api-docs-writing should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/api-docs-writing/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How api-docs-writing Compares
| Feature / Agent | api-docs-writing | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Update or create API documentation after making changes to the public interface of an API. Use when modifying existing endpoints, introducing new endpoints, or when API implementation changes are complete and tested.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# API Documentation Writer Specialist guidance for creating clear, accurate, and developer-friendly API documentation. ## Workflow ### 1. Analyze Changes - Review actual code changes to understand modifications - Identify affected endpoints, parameters, request/response formats, and authentication requirements - Note breaking changes affecting backward compatibility - Consider API version and ensure versioning is properly documented ### 2. Follow Existing Patterns - Study current documentation structure and style before making updates - Maintain consistency in formatting, terminology, and organization - Use the same level of detail and examples as existing documentation - Preserve project-specific documentation conventions ### 3. Document with Precision - Describe each endpoint's purpose and functionality - List all parameters with types, requirements (required/optional), and constraints - Provide accurate request and response examples with realistic data - Document all possible response codes and their meanings - Include authentication and authorization requirements - Note rate limiting or usage restrictions ### 4. Handle API Versioning - Indicate which API version the documentation applies to - Document differences between API versions - Highlight deprecated features and migration paths - Ensure version-specific documentation is properly segregated ### 5. Enhance Developer Experience - Include practical examples for common use cases - Provide clear error response formats and troubleshooting guidance - Add notes about best practices and performance considerations - Include links to related endpoints or resources when relevant ### 6. Quality Assurance - Verify documented endpoints match actual implementation - Ensure examples are syntactically correct and would work in practice - Check that all new parameters and fields are documented - Confirm removed features are marked as deprecated or removed - Validate documentation remains internally consistent ## Handling Ambiguity When encountering ambiguity or needing clarification: - Ask specific questions about intended behavior - Request examples of expected usage patterns - Seek confirmation on backward compatibility implications Documentation should be comprehensive enough that a developer unfamiliar with recent changes can successfully integrate with the API using only the documentation.
Related Skills
ml-paper-writing
Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.
docsbot-ai-automation
Automate Docsbot AI tasks via Rube MCP (Composio). Always search tools first for current schemas.
blog-writing
Write compelling blog posts with proven structure — hook openings, scannable body sections, clear CTAs. Use this skill when drafting blog posts, articles, or content marketing pieces.
writing-skills
Use when creating, updating, or improving agent skills.
writing-project-technical-writing
Writes technical prose (READMEs, ADRs, code comments) in the project's established human voice. Use when creating or editing .md files, writing Swift doc comments, authoring ADRs, or reviewing technical writing for voice consistency.
u09613-writing-and-rhetoric-optimization-for-household-logistics
Operate the "Writing And Rhetoric Optimization for household logistics" capability in production for household logistics workflows. Use when mission execution explicitly requires this capability and outcomes must be reproducible, policy-gated, and handoff-ready.
postmortem-writing
Write effective blameless postmortems with root cause analysis, timelines, and action items. Use when conducting incident reviews, writing postmortem documents, or improving incident response proce...
essay-writing
Writing support (drafting, evaluation and revision) for executives and tech leaders. Support everything from internal culture-building to external technical branding.
copywriting
Write persuasive copy for landing pages, emails, ads, sales pages, and marketing materials. Use when you need to write headlines, CTAs, product descriptions, ad copy, email sequences, or any text meant to drive action. Covers copywriting formulas (AIDA, PAS, FAB), headline writing, emotional triggers, objection handling in copy, and A/B testing. Trigger on "write copy", "copywriting", "landing page copy", "headline", "write a sales page", "ad copy", "email copy", "persuasive writing", "how to write [marketing text]".
Article Writing
Structure and style guidance for law review articles
amazon-writing
Use when writing narrative memos, 6-pagers, 1-pagers, press releases, or PRFAQs in Amazon style. Applies Amazon's no-PowerPoint writing standards with data over adjectives, active voice, and the "so what" test.
algebraic-rewriting
Category-theoretic graph rewriting with DPO, SPO, and SqPO pushouts for C-Sets. Declarative transformation of acset data structures.