cm-doc-syncer

Solid

文档同步 Skill,开发完成后自动更新 README、.claude/ 配置、specs CHANGELOG,保持文档与代码一致

AI & Automation 40 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# cm-doc-syncer — 文档同步器 在所有开发任务完成后,自动同步更新项目文档。确保文档和代码保持一致。 ## 触发条件 由 `/cm-ai` 在最后任务的独立审查前调用;收口阶段只核验已审文档。 ## 输入 - specs 文件夹路径 - 代码项目路径(可多个) - LESSONS.md 中积累的架构决策 - 本 specs 批次全部 feature/task 的原始改动证据、开工快照和最后任务的批准文档写范围 ## 执行步骤 ### 1. 扫描变更 对每个代码项目,先读其 CLAUDE.md「版本控制」字段,按值选变更识别方式(显式分支,不得自行发明): - `remote` / `local` → `git diff {基线}..HEAD` 获取已提交候选;基线先取上一份 CHANGELOG 的 `base-commit`,无则取已确认的 scaffold/初始 commit。无法确认时记录基线缺口,改用下述本批次任务证据,不把全量文件当变更集 - `none` 或项目无 `.git` → 用本批次 handoff/diff 和开工快照定位文件,再核实当前内容;tasks 只确定任务清单,不能仅凭勾选项推断真实改动 - 字段缺失但有 `.git` → 按 `local` 处理 **本轮范围是当前 specs 批次的全部 feature/task,恢复后仍按同一批次;不等于最后一个任务。** 从有效批准清单、tasks 和各任务已有 handoff/diff 记录汇总变更路径;旧任务只读已绑定记录, 最后任务使用正在定稿的真实 diff。不能只凭 checkbox、时间、文件名或任意旧 Review 认定归属。 将本轮已提交差异与所有任务尚未提交的 staged、unstaged、新建/删除文件合并,按当前代码净变化去重。 早期任务已完成却仍未提交的改动属于本轮,不能因它出现在最后任务的开工快照里就当作用户原改动排除。 对照各任务开工快照和实际 diff 按片段排除用户原有改动;同文件混有他人修改、来源或批次不明时只报告缺口,不猜归属。 汇总仅用于读取;最后任务仍只写事先批准的文档范围,不重新修改旧任务源码、状态或凭证。 没有可信证据时明确“同步范围待确认”,不得按全量文件清单替代变更归属证明或宣称全部同步。 随后(与版本控制方式无关): - 识别新增的目录、模块、API、数据模型 - 从 specs 的 requirements.md 获取功能描述;requirements.md 缺失 → 该 feature 跳过描述提取并在最终输出中上报「specs 不完整」,不得凭 tasks.md 猜功能描述 - 从 LESSONS.md 获取架构决策和踩坑记录;文件不存在 → 按 0 条处理,不报错不中断 ### 1.5 增量同步业务地图 按 `../codebase-context/references/writeback.md` 复用本次变更证据:更新相关章节, 没有地图时创建最小局部地图,项目指定文档优先。不得因目录不存在直接跳过, 不得触发全量 scan;所需文档必须在本任务批准范围内,结果进入同一 handoff 与 Review。 ### 2. 更新 README.md 对每个代码项目的 README 进行精炼更新: **必须覆盖:** - **项目简介** — 一句话说清楚是什么 - **架构概览** — 技术栈、目录结构、核心模块关系 - **快速开始** — 安装、配置环境变量、...

Details

Author
kingxiaozhe
Repository
kingxiaozhe/cm-workflow
Created
2 months ago
Last Updated
today
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category