What problem does it solve?
This Skill automates the process of ensuring your codebase is well-documented by auditing existing documentation, identifying gaps, generating missing content, and validating its accuracy against the actual code.
Core Features & Use Cases
- Documentation Audit: Scans for READMEs, guides, inline comments, and changelogs to map existing documentation.
- Gap Identification: Compares documentation against the codebase to find missing, outdated, or incorrect information.
- Automated Generation: Creates new documentation to fill identified gaps, adhering to project conventions.
- Code Validation: Verifies that all documented elements (paths, APIs, behaviors) exist and are accurate in the code.
- Use Case: After a major refactor, use this Skill to ensure all API endpoints and their parameters are correctly documented and that the descriptions match the implemented logic.
Quick Start
Use the docs skill to audit and update the documentation for the authentication module.