Generates and updates professional-grade documentation for codebases, APIs, and complex systems.
The Documentation skill streamlines the creation of essential project documentation by analyzing code behavior and applying industry best practices. It helps developers maintain high-quality README files, comprehensive API references, and meaningful inline comments that explain the reasoning behind logic rather than just the 'what'. Whether you are documenting a new architecture decision or updating an existing technical guide, this skill ensures your documentation is structured for readability, includes practical examples, and stays synchronized with your code changes.
主要功能
01Comprehensive API documentation including schemas and error cases
02Architecture Decision Record (ADR) creation for technical tracking
03Technical guide drafting for troubleshooting and workflows
04Standardized README generation with installation and usage guides
05Intelligent inline commenting focused on 'why' over 'what'
0684 GitHub stars
使用场景
01Building a professional README and Quick Start guide for a new repository
02Documenting REST or GraphQL API endpoints with request/response examples
03Adding explanatory comments to complex logic or non-obvious code paths
