SuperAPI AI 工具集

readme-updater

通用与其它

查看项目

更新于 10-16 03:14

技能介绍

用途:readme-updater 用于让 README 文件跟随项目变化保持最新。当新增功能、项目结构变化、依赖增删、安装说明或配置文件修改,以及用户提到 README 或文档时激活。

主要能力:自动检测变更并映射到 README 章节,例如 package.json 对应依赖章节、新路由对应 API 文档、.env.example 对应环境变量、docker-compose.yml 对应安装步骤、新功能对应功能列表。更新范围涵盖安装(新依赖、设置步骤、前置条件、环境变量)、功能(新能力、功能变更、弃用)、用法(API 变更、新示例、截图)和配置(新选项、环境变量、配置文件变更)。它会保留原有 README 结构、emoji 风格、格式与语气,并可补充缺失章节、同步 CHANGELOG.md、管理截图说明和版本兼容信息。

使用方式:技能根据代码变更提出 README 更新建议,由用户审阅后提交。可与 /docs-gen 命令、CI/CD 流程配合,也可复制到自定义目录添加公司标准。

适用场景:项目功能迭代、依赖调整、安装流程或配置变更后需要同步文档时。

限制:资料未提供具体安装命令、价格、平台支持范围或效果保证;沙箱兼容性为可用,写入 README.md,无需网络和额外配置。