用途
devdocs-sync 用于保持 DevDocs 文档与实际实现进度一致,检测偏差并更新状态。它适用于用户完成一个或多个开发任务后、要求检查文档与代码一致性、需要更新文档进度,或定期同步(如 Sprint 结束时)的场景。
主要能力
- 文档同步:更新追溯矩阵、任务状态,检测文档与代码之间的偏差。
- 多模式运行:
- 默认模式:trace → audit 自动串行,扫描代码中的 @satisfies/@verifies 标注,与文档交叉验证,更新追溯矩阵代码位置列;检测编号体系完整性,防止文档维护债积累。
--check:仅检查,不更新文档。--absorb:吸收模式,从“检查员”进化为“记录员”,支持代码优先开发路径,低风险偏差自动吸收,高风险需确认,自动包含 trace 步骤。--archive:全量归档检查,支持所有文档类型的归档,控制文档膨胀,同时保留历史记录便于追溯。可指定归档类型(requirements、design、tests、tasks)或创建版本快照(--release v1.0.0)。- 指定范围同步:如
/devdocs-sync T-01 T-02,只同步特定任务。
- 偏差报告:生成偏差报告,包含总体进度、偏差汇总、下一步建议,并指派下一步修复 Skill。
- 文档更新:更新 04-dev-tasks.md(任务完成状态、执行检查清单)、03-test-cases.md(追溯矩阵状态、测试通过状态)、01-requirements.md(功能点实现状态,如有状态列)。
- 输出文件:生成 docs/devdocs/00-progress-report.md。
使用方式
- 快速检查:
/devdocs-sync --check,输出偏差报告(仅显示,不写入)。 - 完整同步(默认):
/devdocs-sync,流程为 trace 扫描 → audit 检查 → 显示报告 → 确认 → 更新文档。 - 吸收模式:
/devdocs-sync --absorb,流程为 trace 扫描 → 自动吸收低风险 → 确认高风险 → 生成报告。 - 指定范围:
/devdocs-sync T-01 T-02,只同步特定任务。 - 归档:
/devdocs-sync --archive或指定类型,如/devdocs-sync --archive requirements。
适用场景
- 任务完成后:更新任务状态、测试结果。
- Sprint 结束:全量检查、进度报告。
- 需求变更后:更新需求文档、影响分析。
- 代码审查后:记录设计决策变更。
- 开发完成、任务完成后、测试追溯、需求变更、Bug 修复、洞察确认、项目改造等场景可与其他 Skill 协作。
限制
- 检查约束:必须读取所有 DevDocs 文档后再进行检查;必须生成偏差报告;更新文档前必须询问用户确认(吸收模式低风险除外);检查结果必须可追溯(显示检查方法)。
- 更新约束:不自动删除文档内容,只标记状态;不自动修改代码,只更新文档;保留原有文档结构;更新时记录时间戳。
- 吸收模式约束:低风险吸收仅限状态字段更新;高风险吸收必须用户确认;新增内容必须指定关联编号(AC/F/US);无法确定关联的内容标记为“待手动处理”;吸收操作必须生成吸收报告。
- 安全约束:不执行未知的 shell 命令;测试命令使用项目配置的命令;大规模更新前必须确认。
- 语言规则:支持中英文提问,统一中文回复,使用中文生成文档。
- 其他事实(如收费、价格、平台等)暂未提供。