用途:在代码实现(/speckit.implement)完成后,自动让文档反映已实现的功能。\n\n主要能力:更新 README.md 的用法、安装与功能等区块;为 CHANGELOG.md 添加新功能与变更条目;同步 API 文档与契约;内容来源可对应 spec.md、plan.md、tasks.md。\n\n使用方式:该技能在 /speckit.implement 后自动运行,也可手动执行:npx skills run docs-sync。\n\n标记与保护:自动生成区块由 HTML 注释标记界定,例如 <!-- speckit:start:section-name --> 与 <!-- speckit:end:section-name -->。首个标记之前、最后一个标记之后及不同标记对之间的内容均原样保留,仅更新匹配标记对内内容;不存在标记时以新标记追加。\n\n输出:DocsSyncResult 会列出创建、更新或未变动的文件,各文件被修改的区块,差异摘要(增删改行数)及遇到的错误。\n\n退出码:0 表示全部更新成功;1 表示部分失败;3 表示缺少必需文件。\n\n错误处理:缺少标记时创建新标记并添加内容;标记格式错误则报告错误并跳过该区块;文件权限问题会报告错误并继续处理其他文件;源文件缺失时会报告哪些来源不可用。\n\n限制:资料未提供更多平台、配置、费用或其他能力说明。
docs-sync
办公与效率
更新于 10-15 21:13