用途
sync-docs 用于更新和维护项目文档,重点管理两个文件:CLAUDE.md 和 README.md。其目标是让这两份文档始终与实际项目状态保持同步,并分别服务于各自的读者——CLAUDE.md 面向 Claude 的项目指令,README.md 面向用户和开发者。
主要能力
CLAUDE.md 管理
保持 Claude 的项目指令最新且准确,具体包括:
- 扫描项目结构:检查是否有新的工具、脚本、构建系统。
- 更新构建命令:与 package.json、Makefile 或构建配置同步。
- 添加新模式:记录编码约定、文件组织方式。
- 刷新工具命令:更新 lint、测试、部署相关指令。
- 检查环境配置:核实安装与设置步骤。
README.md 维护
保持公开项目文档最新,具体包括:
- 更新安装说明:检查依赖、环境要求、设置步骤。
- 刷新使用示例:核实代码示例和 API 文档。
- 校验链接:测试外部链接、徽章和引用。
- 更新项目状态:当前功能、路线图、版本信息。
- 检查截图/演示:确保视觉示例为最新。
智能检测流程
- 文件存在性:若 CLAUDE.md 或 README.md 缺失则创建。
- 项目分析:扫描代码库自上次更新以来的变更。
- 交叉引用:将项目结构与文档中的说明进行比对。
- 过时部分:自动识别陈旧信息。
- 一致性检查:确保两份文件相互补充。
校验步骤
- 运行文档中提到的项目命令,验证其可用。
- 从零开始的角度测试安装步骤。
- 校验所有外部链接和引用。
- 检查 CLAUDE.md 的指令是否与当前项目设置一致。
- 确保 README.md 准确反映当前项目状态。
使用方式
资料中未提供具体的安装命令、调用方式或配置步骤,暂未提供。
适用场景
适用于需要维护 CLAUDE.md 和 README.md 的项目,尤其是项目结构、构建命令、依赖或功能发生变化后,希望两份文档与代码库保持同步的场景。
限制
资料中未说明该技能的平台限制、依赖要求或收费情况,暂未提供。