devdocs-sync（开发文档同步）

文档同步

保持 DevDocs 文档与实际实现进度一致，检测偏差并更新状态。

语言规则

• 支持中英文提问
• 统一中文回复
• 使用中文生成文档

触发条件

• 用户完成一个或多个开发任务后
• 用户要求检查文档与代码一致性
• 用户需要更新文档进度
• 定期同步（如 Sprint 结束时）

运行模式

/devdocs-sync                    → 默认模式：trace → audit 自动串行
/devdocs-sync --check            → 仅检查，不更新文档
/devdocs-sync --absorb           → 吸收模式（自动 + 智能补齐）
/devdocs-sync --archive          → 全量归档检查（所有文档类型）
/devdocs-sync --archive requirements  → 仅归档需求文档
/devdocs-sync --archive design        → 仅归档设计文档
/devdocs-sync --archive tests         → 仅归档测试用例
/devdocs-sync --archive tasks         → 仅归档开发任务
/devdocs-sync --archive --release v1.0.0  → 创建版本快照
/devdocs-sync T-01 T-02          → 指定范围同步

默认模式变更

原 --trace 和 --audit 已合并到默认模式。无参数调用时自动执行 trace → audit 串行流程（audit 依赖 trace 的输出，因此不再作为独立子命令）。--absorb 自动包含 trace 步骤。

模式对比

核心理念

文档与代码的关系

文档定义（计划）          代码实现（实际）
     │                        │
     ├── F-XXX 功能点    ←→   ├── 功能模块
     ├── AC-XXX 验收标准 ←→   ├── 业务逻辑
     ├── T-XX 开发任务   ←→   ├── 代码提交
     └── UT/IT/E2E 测试  ←→   └── 测试文件

核心原则：

• 文档是计划，代码是实现
• 偏差是正常的，关键是及时同步
• 同步应该双向：文档→代码（指导）、代码→文档（记录）

同步时机

工作流程

1. 读取 DevDocs 文档
   │
   ▼
2. 扫描代码库（工作区状态）
   ├── 检查文件是否存在（Glob）
   ├── 运行测试（获取实时结果）
   ├── 检查未提交变更（git status）
   └── 参考提交记录（git log，辅助）
   │
   ▼
3. 对比分析
   ├── 任务完成状态
   ├── 测试覆盖情况
   └── 功能实现状态
   │
   ▼
4. 生成偏差报告
   │
   ▼
5. 询问用户确认更新
   │
   ▼
6. 更新文档

重要：检查基于当前工作区状态，而非仅依赖 git 提交历史。

模式详解

默认模式（trace → audit 自动串行）

无参数调用时自动执行两步流程：

1. trace 阶段：扫描代码中的 @satisfies/@verifies 标注，与文档交叉验证，更新追溯矩阵代码位置列。详见 trace-mode.md
2. audit 阶段：检测编号体系完整性，防止文档维护债积累。检查 AC 覆盖、F 任务闭环、INS 转化、孤立编号。详见 audit-mode.md

audit 依赖 trace 的扫描结果，因此自动串行执行，不再作为独立子命令。

吸收模式 (--absorb)

从"检查员"进化为"记录员"，支持代码优先开发路径。低风险偏差自动吸收，高风险需确认。自动包含 trace 步骤。

详见 absorb-mode.md

文档归档 (--archive)

支持所有文档类型的归档，控制文档膨胀，同时保留历史记录便于追溯：

归档时支持级联：归档 F-001 时可同时归档关联的设计/测试/任务。

详见 archive.md

同步命令

快速检查

/devdocs-sync --check
# 输出: 偏差报告（仅显示，不写入）

完整同步（默认）

/devdocs-sync
# 流程: trace 扫描 → audit 检查 → 显示报告 → 确认 → 更新文档

吸收模式

/devdocs-sync --absorb
# 流程: trace 扫描 → 自动吸收低风险 → 确认高风险 → 生成报告

指定范围

/devdocs-sync T-01 T-02
# 只同步特定任务

输出文件

进度报告

生成 docs/devdocs/00-progress-report.md，包含总体进度、偏差汇总、下一步建议。

文档更新

约束

检查约束

• 必须读取所有 DevDocs 文档后再进行检查
• 必须生成偏差报告
• 更新文档前必须询问用户确认（吸收模式低风险除外）
• 检查结果必须可追溯（显示检查方法）

更新约束

• 不自动删除文档内容，只标记状态
• 不自动修改代码，只更新文档
• 保留原有文档结构
• 更新时记录时间戳

吸收模式约束

• 低风险吸收仅限状态字段更新
• 高风险吸收必须用户确认
• 新增内容必须指定关联编号（AC/F/US）
• 无法确定关联的内容标记为"待手动处理"
• 吸收操作必须生成吸收报告

安全约束

• 不执行未知的 shell 命令
• 测试命令使用项目配置的命令
• 大规模更新前必须确认

Skill 协作

参考资料

• absorb-mode.md - 吸收模式详解
• audit-mode.md - 追溯健康度检查
• trace-mode.md - 代码追溯扫描
• archive.md - 任务归档功能
• examples.md - 使用示例与偏差类型

偏差修复路由（调度器功能）

当检测到偏差时，必须在报告中指派下一步修复 Skill：

调度器原则：偏差报告不能只列出问题，必须给出明确的修复路由。

调用说明

任务完成后直接运行：

/devdocs-sync            # trace → audit 自动串行 → 显示报告 → 确认更新
  或 --absorb            # trace + 自动吸收低风险 → 确认高风险

默认模式已将 trace 和 audit 合并为自动串行流程，无需手动分两步调用。

批量确认优化

同一会话内的低风险变更（状态更新、进度统计等）合并为文档级批量确认，而非逐个确认。

子 Agent 摘要格式

当本 Skill 作为子 Agent 运行时，返回以下结构化摘要：

skill: devdocs-sync
mode: default | check | absorb | archive
trace_results:
  satisfies_found: X
  verifies_found: X
  coverage: "XX%"
audit_results:
  orphan_ids: []
  missing_tests: []
  health_score: "XX%"
deviations:
  total: X
  auto_absorbed: X  # absorb 模式
  needs_confirm: X
status: synced | deviations_found
output_file: docs/devdocs/00-progress-report.md

下一步

同步完成后，根据进度报告中的偏差修复路由执行对应 Skill。