docs: 完成任务 #10 归档

ila
2026-08-10 11:55:07 +08:00
parent 0b652e3723
commit 6451a4bbf1
@@ -1,9 +1,9 @@
# 10 需求记录与流转规则
- 类型:需求 / 缺陷 / 重构
- 所属 Epic:#
- 所属 MVP / 版本:#
- 状态:待验收 / 已完成
- 类型:开发流程优化
- 所属 Epic:无
- 所属 MVP / 版本:无
- 状态:待验收
- 日期:2026-08-10
- Gitea 工单:http://ilaer.eicp.net:8418/opc/dev_harness/issues/10
- Wiki 页面:Task-10-需求记录与流转规则
@@ -11,32 +11,68 @@
## 背景与目标
<!-- 原来有什么问题,这次达到什么结果。 -->
工单原本能够记录目标、方案和验收标准,但没有固定字段保存需求来源、关键原始表达和实施期间的需求变化,未来可能难以追溯用户最初目的以及最终方案变化原因。
本任务以最小方式补强需求可追踪性,同时保持 Gitea 工单、Wiki 和本地镜像的事实来源边界。
## 最终方案
<!-- 说明实际实现。与建单方案不同之处必须写清原因。 -->
- 单元任务模板增加“原始需求”:来源、提出时间、关键原话或脱敏摘要。
- 只保存表达用户目的、场景和限制所需的少量原话,不臆造用户原话。
- 目标、非目标、已确认方案、验收标准和文档影响构成正式任务需求。
- 增加“需求变化记录”,记录影响范围、接口、数据、风险或验收的变化日期、内容、原因和用户确认。
- 会改变已确认结果的变化仍须先更新工单并等待再次确认。
- 不复制完整聊天,不保存 Agent 内部推理,不写入敏感信息;敏感原话必须脱敏。
- 关键原始需求、正式任务需求、讨论和变化保存在 Gitea 工单,不导出全文。
- 长期产品需求、业务规则和系统边界进入 Wiki 主题页并导出 `docs/`。
- 完成结果进入 Wiki 任务归档并导出 `docs/task/`。
- Harness 检查任务模板、Agent 规则和 Wiki 章节。
- 没有新增需求数据库、同步脚本、Skill 或聊天抓取功能。
实施结果与已确认方案一致。
## 修改文件
- `<文件>`:<改动说明>
- `AGENTS.md`:增加需求记录和事实来源边界。
- `.gitea/issue_template/task.md`:增加原始需求和需求变化记录。
- `dev_scripts/check_harness.py`:检查需求追踪字段和规则。
- `tests/test_harness_docs.py`:验证缺失需求追踪字段会被报告。
- `docs/01-workflow.md`:Development-Workflow Wiki 的只读镜像。
- `docs/03-business-rules-and-glossary.md`:Business-Rules-and-Glossary Wiki 的只读镜像。
- `wiki-docs.json`:登记本任务 Wiki 归档镜像。
- `docs/task/10-需求记录与流转规则.md`:本页的自动导出镜像。
## 验收结果
| 验收标准 | 结果 |
|---|---|
| | 通过 / 未通过 |
| 模板记录来源、时间和关键原话 | 通过 |
| 模板记录需求变化四项信息 | 通过 |
| 工单保存正式任务需求和变化 | 通过 |
| 长期结论进入 Wiki 和 docs 镜像 | 通过 |
| 不保存完整聊天、内部推理和敏感信息 | 通过 |
| 不导出 Gitea 工单全文 | 通过 |
| Harness 检测字段缺失 | 通过 |
| 未增加脚本或聊天抓取功能 | 通过 |
| Wiki 先更新、确认再导出 | 通过 |
| 测试和严格检查 | 通过 |
| 实现和归档提交分离 | 通过 |
## 测试
- 执行命令:`<命令>`
- 结果:
- **未验证部分**:<!-- 必填;没有就写“无”。 -->
## 遗留问题
<!-- 没有就删除本节。 -->
- 执行命令:`python -m unittest discover -s tests -v`
- 结果:21/21 通过。
- 执行命令:`python dev_scripts/check_harness.py --strict`
- 结果:通过。
- 执行命令:`python dev_scripts/sync_wiki_docs.py --check`
- 结果:归档前 19/19 映射一致;归档后重新检查 20/20。
- 执行命令:`python -m compileall -q dev_scripts tests`
- 结果:通过。
- 执行命令:`git diff --check`
- 结果:通过。
- **未验证部分**:未实现聊天自动抓取或 Gitea 工单全文导出,这些是已确认的非目标。
## 相关提交
- `<提交哈希>` <提交说明>
- `353bd97` `feat: 增加需求记录规则 (#10)`
- 归档提交哈希在提交后回写 Gitea 工单,避免归档自引用。