Professional Documentation
Automates and standardizes the creation, auditing, and improvement of code comments, API references, and system documentation.
This skill acts as an intelligent router for all documentation tasks, distinguishing between inline code comment maintenance and high-level system documentation. It streamlines the writing process by applying language-specific best practices, maintaining consistent directory structures (like /docs/api/ or /docs/architecture/), and ensuring README files remain actionable with runnable examples. By delegating to specialized subagents and using 'The Engineer' persona, it helps developers maintain high-quality, professional technical documentation across entire repositories with minimal manual oversight.
主な機能
01Intelligent routing between inline code comments and system-level markdown documentation
02Automated audit and cleanup of outdated, redundant, or unclear code comments
03Enforcement of project-wide documentation location standards and naming conventions
04Integration with Mermaid for architectural visualization and flow diagrams
05Standardized generation of API references, architecture guides, and project READMEs
06107 GitHub stars
ユースケース
01Auditing and cleaning up messy inline comments across a legacy codebase or unstaged changes
02Generating comprehensive API documentation and architecture guides for a new microservice
03Updating root README files to ensure quick-start guides and installation steps are current and runnable