readme-updater

The readme-updater skill acts as an autonomous documentation steward for your software projects, ensuring that your primary project documentation never drifts from the current state of your codebase. It is designed for developers who prioritize maintainable projects and wish to reduce the manual overhead of updating installation guides, feature lists, and configuration references every time a pull request is merged or a feature is added.

• Automatically monitors key files like package.json, docker-compose.yml, and .env.example to trigger documentation updates.
• Dynamically updates the Installation section with new dependencies or setup steps when changes are detected.
• Maintains an accurate Features list by observing code additions and new capabilities implemented in the project structure.
• Keeps Configuration sections, API references, and environment variable documentation current based on codebase modifications.
• Preserves original README formatting, emoji styles, and tone while surgically inserting or updating relevant sections.
• Integrates with broader documentation workflows, including the @docs-writer sub-agent for deep dives and api-documenter for OpenAPI/Swagger generation.
• Tracks version compatibility and supports integration with CHANGELOG.md for historical documentation synchronization.

Usage involves constant background monitoring of the project workspace. When significant project structure changes, dependency modifications, or setup instruction adjustments are detected, the skill suggests precise patches to your README. It is highly effective for teams using agile methodologies where features are shipped frequently. It requires no complex configuration and works reliably across diverse project environments. Note that this skill is optimized for Markdown-based documentation and works best when the README follows a standard structural layout. It supports automated workflows in CI/CD pipelines to ensure documentation quality is validated alongside code quality. Use this when you want to shift your focus from writing repetitive documentation to building features, knowing that your project's "front door" remains informative and up-to-date.