完善AI-NSES文档治理规则
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# Agent Handoff 标题
|
||||
|
||||
## 1. 背景
|
||||
|
||||
说明本次任务从哪里来,要解决什么问题。
|
||||
|
||||
## 2. 目标
|
||||
|
||||
- 必须完成事项 1:
|
||||
- 必须完成事项 2:
|
||||
|
||||
## 3. 边界
|
||||
|
||||
- 不做事项 1:
|
||||
- 不做事项 2:
|
||||
|
||||
## 4. 必读文档
|
||||
|
||||
1. `AGENTS.md`
|
||||
2. `CONTEXT.md`
|
||||
3. `PROJECT_STATE.md`
|
||||
4. 项目文档索引
|
||||
5. 本次相关 Spec / Change Request / Contract
|
||||
|
||||
## 5. 影响范围
|
||||
|
||||
| 范围 | 是否影响 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 后端 | 是 / 否 | |
|
||||
| 前端 | 是 / 否 | |
|
||||
| 数据库 | 是 / 否 | |
|
||||
| 权限 / 安全 / 审计 | 是 / 否 | |
|
||||
| 第三方系统 | 是 / 否 | |
|
||||
| 测试数据 | 是 / 否 | |
|
||||
| 文档 | 是 / 否 | |
|
||||
|
||||
## 6. 验收标准
|
||||
|
||||
- Given / When / Then:
|
||||
- Given / When / Then:
|
||||
|
||||
## 7. 允许操作
|
||||
|
||||
- 是否允许改代码:
|
||||
- 是否允许改文档:
|
||||
- 是否允许造测试数据:
|
||||
- 是否允许执行写操作:
|
||||
- 是否允许清理数据:
|
||||
|
||||
## 8. 输出要求
|
||||
|
||||
- 完成内容:
|
||||
- 未完成内容:
|
||||
- 代码或文档位置:
|
||||
- 测试命令和结果:
|
||||
- 风险:
|
||||
- 下一步建议:
|
||||
@@ -0,0 +1,61 @@
|
||||
# Change Request 标题
|
||||
|
||||
| 项 | 内容 |
|
||||
| --- | --- |
|
||||
| 状态 | Draft / Approved / Implemented / Superseded / Archived |
|
||||
| 日期 | YYYY-MM-DD |
|
||||
| 提出人 | 按实际填写 |
|
||||
| 关联 Spec | 路径或编号 |
|
||||
| 影响范围 | Backend / Frontend / Test / Docs / Security / Integration |
|
||||
|
||||
## 1. 变更背景
|
||||
|
||||
说明为什么要改,当前问题是什么。
|
||||
|
||||
## 2. 原规则
|
||||
|
||||
- 原规则 1:
|
||||
- 原规则 2:
|
||||
|
||||
## 3. 新规则
|
||||
|
||||
- 新规则 1:
|
||||
- 新规则 2:
|
||||
|
||||
## 4. 影响范围
|
||||
|
||||
| 范围 | 是否影响 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 用户流程 | 是 / 否 | |
|
||||
| 后端接口 | 是 / 否 | |
|
||||
| 前端交互 | 是 / 否 | |
|
||||
| 数据模型 | 是 / 否 | |
|
||||
| 权限 / 安全 / 审计 | 是 / 否 | |
|
||||
| 第三方契约 | 是 / 否 | |
|
||||
| 测试数据 / 迁移 | 是 / 否 | |
|
||||
|
||||
## 5. 兼容和迁移
|
||||
|
||||
- 是否兼容旧数据:
|
||||
- 是否需要数据清理:
|
||||
- 是否影响生产:
|
||||
- 回滚或恢复方式:
|
||||
|
||||
## 6. 验收标准
|
||||
|
||||
- Given / When / Then:
|
||||
- Given / When / Then:
|
||||
|
||||
## 7. Agent 待办
|
||||
|
||||
| Agent / 角色 | 待办 | 验证 |
|
||||
| --- | --- | --- |
|
||||
| 后端 | | |
|
||||
| 前端 | | |
|
||||
| 测试 | | |
|
||||
| 文档 | | |
|
||||
|
||||
## 8. 文档更新
|
||||
|
||||
- 需要更新的文档:
|
||||
- 不需要更新的文档及原因:
|
||||
@@ -18,4 +18,6 @@
|
||||
- `WORKFLOW.template.md`:业务流程文档模板。
|
||||
- `ADR.template.md`:架构决策记录模板。
|
||||
- `SPEC.template.md`:功能规格模板。
|
||||
- `CHANGE_REQUEST.template.md`:已确认需求的变更请求模板。
|
||||
- `AGENT_HANDOFF.template.md`:给后端、前端、测试或文档 agent 的任务交接模板。
|
||||
- `ARCHITECTURE.template.md`:架构说明模板。
|
||||
|
||||
@@ -2,9 +2,11 @@
|
||||
|
||||
| 项 | 内容 |
|
||||
| --- | --- |
|
||||
| 状态 | Draft / Approved / Implemented / Archived |
|
||||
| 状态 | Draft / Approved / Implemented / Superseded / Archived |
|
||||
| 日期 | YYYY-MM-DD |
|
||||
| 负责人 | 按实际填写 |
|
||||
| 需求来源 | 用户 / 客户 / 业务方 / 内部发现 |
|
||||
| 关联 Change Request | 可为空 |
|
||||
|
||||
## 1. 背景
|
||||
|
||||
@@ -24,26 +26,50 @@
|
||||
|
||||
说明谁会使用这个能力,在哪些场景使用。
|
||||
|
||||
## 5. 业务规则
|
||||
## 5. Definition of Ready
|
||||
|
||||
- 需求来源已确认:
|
||||
- 目标和非目标已确认:
|
||||
- 影响范围已确认:
|
||||
- 权限、安全、审计和数据边界已确认:
|
||||
- 前后端 / 测试分工已确认:
|
||||
- 未确认问题已列出:
|
||||
|
||||
## 6. 业务规则
|
||||
|
||||
- 规则 1:
|
||||
- 规则 2:
|
||||
|
||||
## 6. 接口或交互契约
|
||||
## 7. 接口或交互契约
|
||||
|
||||
说明请求、响应、权限、安全、审计和兼容性要求。
|
||||
|
||||
## 7. 验收标准
|
||||
## 8. 需求追踪表
|
||||
|
||||
| 需求项 | 后端状态 | 前端状态 | 测试状态 | 文档位置 | 当前状态 |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 需求 1 | Pending / Done / N/A | Pending / Done / N/A | Pending / Done / Blocked | | Draft / Approved / Implemented |
|
||||
|
||||
## 9. 验收标准
|
||||
|
||||
- Given / When / Then:
|
||||
- Given / When / Then:
|
||||
|
||||
## 8. 测试范围
|
||||
## 10. 测试范围
|
||||
|
||||
- 单元测试:
|
||||
- 集成测试:
|
||||
- 手工验证:
|
||||
|
||||
## 9. 文档更新
|
||||
## 11. Definition of Done
|
||||
|
||||
- 实现满足 Spec:
|
||||
- 测试已运行或说明无法运行原因:
|
||||
- 需求追踪表已更新:
|
||||
- Project State 已更新:
|
||||
- 接口、安全、权限、审计、集成契约已同步:
|
||||
- 无 Secret、真实数据、构建产物或无关本地变更:
|
||||
|
||||
## 12. 文档更新
|
||||
|
||||
完成后检查 Domain、Architecture、Workflow、ADR、Project State 是否需要更新。
|
||||
|
||||
Reference in New Issue
Block a user