用途:readme-updater 用于让 README 文件随项目变化保持最新。当新增功能、项目结构变化、依赖增删、安装步骤或配置文件修改,以及用户提到 README 或文档时激活。
主要能力:可更新安装(新依赖、设置步骤、前置条件、环境变量)、功能(新增能力、功能变更、弃用)、用法(API 变更、新示例、截图)和配置(新选项、环境变量、配置文件变更)等章节。检测逻辑包括 package.json、新路由、.env.example、docker-compose.yml 和新功能等变化,并映射到对应 README 章节。更新时保留原有结构、emoji 风格、格式与语气,可补充缺失章节,跟踪版本兼容性,与 CHANGELOG.md 同步,并管理截图说明。
使用方式:技能根据代码变更建议 README 更新,由用户审阅并提交。可与 /docs-gen 命令、CI/CD 流程配合;如需完整文档策略可调用 @docs-writer 子代理。支持沙箱与非沙箱环境,写入 README.md,无需网络或额外配置。可通过复制技能目录并编辑来定制公司 README 标准。
适用场景:项目迭代中需要同步维护 README 的开发者与团队。
限制:资料未提供具体安装命令、收费、价格、平台支持范围及实际效果数据,暂未提供。