readme-updater

readme-updater 技能为您的软件项目提供自动化的文档管理，确保项目的主要文档始终与代码库的当前状态保持一致。它专为那些重视项目可维护性，并希望减少每次合并 Pull Request 或新增功能时手动更新安装指南、功能列表及配置参考等琐碎工作的开发者而设计。

• 自动监控 package.json、docker-compose.yml 和 .env.example 等关键文件，以触发文档更新。
• 当检测到更改时，动态更新安装 (Installation) 部分，包含新的依赖项或安装步骤。
• 通过观察代码添加内容和项目中实现的新功能，维护准确的功能 (Features) 列表。
• 根据代码库的修改，即时更新配置 (Configuration) 部分、API 参考和环境变量文档。
• 在插入或更新相关部分的同时，保留原始 README 的格式、Emoji 风格和语调。
• 与更广泛的文档工作流程集成，包括用于深入撰写的 @docs-writer 子代理和用于 OpenAPI/Swagger 生成的 api-documenter。
• 跟踪版本兼容性，并支持与 CHANGELOG.md 集成，以实现历史文档的同步。

该技能的使用涉及对项目工作区的持续后台监控。当检测到显著的项目结构变更、依赖项调整或安装说明修改时，该技能会建议对您的 README 进行精确修补。对于使用敏捷开发方法、频繁发布功能的团队来说，此技能效果显著。它无需复杂的配置，可在各种项目环境中可靠运行。请注意，此技能针对基于 Markdown 的文档进行了优化，当 README 遵循标准结构布局时效果最佳。它支持 CI/CD 流水线中的自动化工作流程，以确保文档质量与代码质量同步验证。当您希望将重点从编写重复性文档转向构建功能，并确信项目的「门面」始终保持信息丰富且最新时，请使用此技能。