version: "1.0.1"
name: delivery
displayName: 交付物格式化与汇总
description: 对编码阶段增量积累的变更记录和代码审查阶段产出的技术参考文档进行最终格式化、完整性校验和交付展示。
triggers: ["生成交付物", "交付", "/deliver", "格式化变更清单"]
autoTrigger: true
version: '1.0.2'
交付物格式化与汇总
技能目标
对编码过程中增量维护的变更记录文档和代码审查阶段产出的技术参考文档进行最终格式化和完整性校验,形成正式的交付包。
本技能不从零生成文档——变更记录在编码阶段逐条积累,技术参考文档在代码审查阶段产出。本技能负责"最后一公里"的格式化和校验。
核心原则
- 格式化而非重建:基于已有的增量记录做格式整理,不重新阅读全部代码
- 完整性校验:将变更记录与
git diff main...HEAD 对账,确保无遗漏
- 高风险标注:确认所有高风险变更已在"需关注"中列出
- 需求关联:所有交付物必须关联需求编号
工作流程
第一步:变更清单定稿
输入:编码阶段积累的 docs/delivery/SV-xxxxx-changelist.md
- 读取变更记录文档中的所有条目
- 执行
git diff main...HEAD --name-status 获取实际变更文件列表
- 对账校验:
- 记录中的文件是否与 diff 完全匹配
- 遗漏的文件 → 补充记录
- 多余的记录 → 确认后移除
- 按层级重新分组(新增/修改/删除),统一格式
- 确认"需关注:高风险变更"部分完整
定稿格式:
markdown
# 变更清单 SV-xxxxx
## 新增
-[文件路径] — [功能说明]
## 修改
-[文件路径] — [变更说明]
## 删除
-[文件路径] — [删除原因]
## 需关注:高风险变更
-[文件#方法名] — [说明:被什么替代,或为什么移除/注释]
第二步:技术参考文档校验
输入:代码审查阶段产出的 docs/delivery/SV-xxxxx-tech-ref.md
- 检查文档结构是否完整(6 个标准章节)
- 检查接口清单是否与变更清单中的接口变更一致
- 补齐缺失章节(如无配置变更则标注"无")
第三步:交付展示
展示所有交付物摘要,让用户选择后续操作:
- 提交 PR:自动填写 PR 标题和描述,附变更清单和技术参考文档
- 本地合并:将 feature 分支合并到主分支
- 保留分支:不做合并操作
文件保存位置
- 变更清单:
docs/delivery/SV-xxxxx-changelist.md
- 技术参考文档:
docs/delivery/SV-xxxxx-tech-ref.md
补救场景
当通过 /deliver 独立触发时(未经 /code 正常流程),本技能回退到从 git diff 重新生成模式:
- 从
git diff main...HEAD 提取所有变更,生成变更清单
- 读取变更文件内容,生成技术参考文档
- 提示用户:此模式下文档精度可能低于正常流程中的增量记录