What problem does it solve?
Keeping project documentation, changelogs, and version numbers consistent and up-to-date across a large project is often a manual and time-consuming task. This Skill automates these processes, ensuring accuracy and saving developer time.
Core Features & Use Cases
- Automated Documentation Updates: Systematically updates
README.md, CHANGELOG.md, and API documentation based on project changes.
- Version Management: Guides through semantic versioning and release workflows, ensuring consistent version numbers across all project files.
- Consistency Validation: Checks for consistent version numbers, valid links, and accurate feature statuses across all documentation.
- Use Case: Before a new product release, a project manager needs to ensure all documentation reflects the latest features and version. This skill provides a checklist and patterns to automatically update the
README.md, generate a changelog from recent commits, and synchronize API documentation.
Quick Start
Use the docs-management skill to update the project's package.json version to 1.2.0, then generate a new changelog entry based on recent commits, and update the README.md with the new version.
