What problem does it solve?
This Skill ensures that your project's documentation, including functional specifications and README files, stays up-to-date with code changes, preventing documentation drift and improving project clarity.
Core Features & Use Cases
- Automatic Spec Updates: Updates functional specs based on code commits (
feat, fix, refactor).
- README Synchronization: Proposes updates to README files if changes impact installation, configuration, or usage.
- Lessons Learned Capture: Identifies and records valuable insights from code changes in memory files.
- Initial Spec Bootstrapping: Scans the codebase to generate initial functional specifications for new projects.
- Use Case: After adding a new payment gateway feature, this Skill automatically updates the
payment functional spec with new user stories and ensures the README reflects any new configuration options.
Quick Start
Run the spec-update skill to bootstrap documentation for a new project.