Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.
Detected risks:
The 'readme-updater' skill is designed to keep your project's README file up-to-date by automatically suggesting changes based on the code updates you make. As projects evolve, whether through new features, structural changes, or updated dependencies, the README often needs to be adjusted to accurately reflect these modifications. This skill streamlines the process, ensuring your documentation remains relevant and reflective of the latest project state, helping avoid outdated or incomplete README files that can confuse users or developers.
The skill automatically detects significant code changes such as new dependencies, updated setup instructions, new features, API changes, and modifications to configuration files. It uses predefined triggers like changes in package.json, docker-compose.yml, and new features to suggest appropriate updates to the README.
The skill follows a set of predefined mappings for different types of code changes (e.g., new dependencies lead to changes in the Installation section). Customization options are not explicitly mentioned, but it preserves the structure and formatting of the existing README, allowing it to remain consistent with your project's existing style.
While the skill itself is language-agnostic, the documentation examples and suggestions primarily cater to JavaScript, Node.js, and related environments (e.g., npm, Docker). For other languages, the underlying logic can still be applied, but the specific examples may need to be adjusted to fit the language or framework used.
The skill is limited to suggesting updates based on specific code changes. It does not generate complete documentation or provide in-depth content like a full user guide. It focuses on maintaining the README file's accuracy and keeping it in sync with code modifications, but it does not create documentation beyond what's necessary for project setup, features, and usage.
Quick Setup:
.claude/skills/Repository
alirezarezvani/claude-code-tresor