关于 docs-sync
docs-sync 会在 `/speckit.implement` 完成后，根据实现内容和规范文件更新项目文档。它维护 README.md、CHANGELOG.md 和 API 文档，并保留标记区域以外的内容。
主要功能
- 01更新 README.md 用法和功能部分
- 02添加 CHANGELOG.md 条目
- 03同步 API 文档
- 04保留标记之外的内容
- 05报告变更文件和差异摘要
适用场景
- 01实现完成后更新文档
- 02在变更日志中记录已完成工作
- 03使 API 文档与契约保持一致
- 04检查文档更新和错误
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/docs-sync确认已加载。
附带文件scripts/sync.sh
详细介绍
docs-sync
在 /speckit.implement 完成后，将文档与实现同步。
用途
此技能会自动更新文档，以反映已实现的功能。它会：
- 更新 README.md：添加或更新用法部分，并包含实现详情
- 更新 CHANGELOG.md：为新功能和变更添加条目
- 更新 API 文档：使 API 文档与契约保持同步
- 保留用户内容：绝不修改 speckit 标记以外的内容
标记系统
docs-sync 使用 HTML 注释标记来划定自动生成的部分：
Auto-generated content here
这些标记之外的内容会原样保留。
输出
该技能会输出一个 DocsSyncResult，显示：
- 已创建、已更新或未更改的文件
- 各文件中已修改的部分
- 差异摘要（新增、删除或更改的行数）
- 遇到的任何错误
用法
此技能会在 /speckit.implement 之后自动运行。你也可以手动运行：
npx skills run docs-sync
退出代码
| 代码 | 状态 | 含义 |
|---|---|---|
| 0 | 成功 | 所有更新均成功 |
| 1 | 部分成功 | 部分更新失败 |
| 3 | 错误 | 缺少必需文件 |
更新的部分
README.md
| 部分 | 标记 | 内容来源 |
|---|---|---|
| 用法 | `` | spec.md 用户故事 |
| 安装 | `` | plan.md 依赖项 |
| 功能 | `` | spec.md 功能需求 |
CHANGELOG.md
| 部分 | 标记 | 内容来源 |
|---|---|---|
| 未发布 | `` | tasks.md 已完成的任务 |
保留规则
- 始终保留第一个标记之前的内容
- 始终保留最后一个标记之后的内容
- 始终保留不同标记对之间的内容
- 仅更新匹配标记对内的内容
- 如果不存在标记，则在末尾添加内容和新标记
错误处理
- 缺少标记：创建新标记并添加内容
- 标记格式错误：报告错误并跳过该部分
- 文件权限问题：报告错误，并继续处理其他文件
- 缺少源文件：报告哪些源文件不可用
评论
支持 Markdown