What problem does it solve?
This Skill solves the problem of outdated or inconsistent documentation by synchronizing technical documentation directly with the implementation code, ensuring that READMEs, JSDoc, and inline comments remain accurate and useful.
Core Features & Use Cases
- Automated Documentation: Generates JSDoc for functions, classes, and types based on actual code behavior.
- Contextual Comments: Adds key-step inline comments that explain the why behind complex logic.
- README Synchronization: Keeps project-level documentation, environment requirements, and usage examples in sync with the codebase.
- Use Case: When a developer updates a complex utility library, they can trigger this skill to automatically refresh the JSDoc and README, ensuring the documentation reflects the latest API changes without manual drafting.
Quick Start
Use the doc-helper skill to scan the current directory and update all JSDoc and README files based on the implementation.