api-doc-writer
CommunityGenerate accurate API reference docs.
Software Engineering#developer tools#code generation#documentation automation#api documentation#diataxis#reference docs
Authormeriley
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation of comprehensive API reference documentation, ensuring accuracy and adherence to the Diátaxis Reference pattern, thereby saving significant developer time and improving documentation quality.
Core Features & Use Cases
- Automated API Documentation: Generates structured reference docs directly from source code.
- Signature Verification: Guarantees that documented API signatures precisely match the source code, eliminating discrepancies.
- Diátaxis Compliance: Strictly follows the Diátaxis framework for information-oriented documentation.
- Use Case: When a new API endpoint is developed, use this Skill to instantly generate its reference documentation, including parameters, return types, and error conditions, ensuring it's ready for developers.
Quick Start
Use the api-doc-writer skill to document the 'pkg/services/task' package.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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-doc-writer Download link: https://github.com/meriley/claude-code-skills/archive/main.zip#api-doc-writer 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.