跳转至

<标题> - 实现报告

一个功能模块一份报告,不要多个功能混在一个文件里。 路径:docs/03-dev/reports/<STORY_ID>-<标题>.md


1. 基本信息

项目 值
故事 ID
标题 <...>
分支 <branch>
Agent
开始时间
完成时间
状态 dev / unit_done / integ_done
关联契约 openapi.yaml#<operationId>

2. 目标与范围

2.1 目标

<一句话说明这个功能要解决什么问题。>

2.2 范围内

  • <...>
  • <...>

2.3 范围外

  • <...>

3. 改动文件

文件 类型 说明
<path> 新增/修改 <...>
<path> 新增/修改 <...>

3.1 未授权文件检查

  • 没有修改文件所有权之外的文件
  • 没有修改已上线的迁移
  • 没有修改共享契约(如有,记录 CR 编号)

4. 实现要点

4.1 业务逻辑

  1. <...>
  2. <...>

4.2 权限

  • <谁能做什么>
  • <对象级校验>

4.3 事务与并发

  • 事务边界:<...>
  • 幂等:<...>
  • 乐观锁/唯一约束:<...>

4.4 错误处理

场景 状态码 错误码
<...> <...> <...>

4.5 可观测性

  • 日志字段:<...>
  • 指标:<...>
  • 审计:<...>

5. 测试结果

5.1 单元测试

命令:<command>
结果:<x passed / y failed>
覆盖率:<...>

5.2 集成测试

命令:<command>
结果:<x passed / y failed>

5.3 静态检查

go vet:通过
golangci-lint:通过
race:通过

5.4 E2E(如已执行)

  • Manifest:docs/04-qa/manifests/<STORY_ID>.json
  • 结果:
  • 报告:docs/04-qa/...docx

6. 验收标准覆盖

AC 描述 测试/步骤 结果
AC-1 <...> <test name> pass
AC-2 <...> <test name> pass
AC-3 <...> <test name> pass

7. 已知限制与技术债

  • <...>
  • <...>

如果有未完成项,必须写清楚影响和计划,不要隐藏。


8. 证据

证据 路径/链接
提交 <commit sha>
CI 运行 <url / run id>
E2E manifest <path>
截图目录 <path>
测试日志 <path>

9. 变更记录

时间 变更 作者
<...> 初稿 <...>