完善AI-NSES文档治理规则
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
| 项 | 内容 |
|
||||
| --- | --- |
|
||||
| Version | 0.1 |
|
||||
| Version | 0.2 |
|
||||
| Scope | 可复用软件工程标准 |
|
||||
| Audience | 人类开发者、产品人员、架构师、AI Agent |
|
||||
|
||||
@@ -137,10 +137,12 @@ project/
|
||||
|
||||
职责:记录具体功能规格。每一个 Feature 对应一个 Spec。
|
||||
|
||||
生命周期:Draft -> Approved -> Implemented -> Archived。
|
||||
生命周期:Draft -> Approved -> Implemented -> Superseded / Archived。
|
||||
|
||||
规则:Spec 完成以后保留,不删除。
|
||||
|
||||
如果既有项目已经有 `docs/project/requirements/` 等历史目录,可以通过项目级 adoption 文档建立映射;但新增重要 Feature 仍应使用 Spec 模板的结构表达背景、目标、非目标、业务规则、接口或交互契约、验收标准和测试范围。
|
||||
|
||||
### docs/guidelines/
|
||||
|
||||
读者:开发、测试和 AI Agent。
|
||||
@@ -208,6 +210,70 @@ Idea
|
||||
|
||||
Documentation Update 属于 Definition of Done,不能跳过。
|
||||
|
||||
### 8.1 Definition of Ready
|
||||
|
||||
进入实现前,复杂 Feature 或会影响跨模块协作的变更必须满足:
|
||||
|
||||
- 需求来源明确,知道是谁提出、解决什么问题。
|
||||
- 目标和非目标明确,避免实现时扩大范围。
|
||||
- 受影响的用户、业务流程、接口、数据模型、权限、安全、审计或外部系统边界已经列出。
|
||||
- 前端、后端、测试或第三方系统的分工已经明确。
|
||||
- 验收标准已经可测试,至少有主要 Given / When / Then 场景。
|
||||
- 未确认问题已经列出;如果问题影响业务规则或安全边界,应先确认再实现。
|
||||
|
||||
简单 bugfix 或纯内部重构可以不用新建完整 Spec,但仍应在任务说明中写清目标、范围和验证方式。
|
||||
|
||||
### 8.2 Definition of Done
|
||||
|
||||
Feature 完成前必须确认:
|
||||
|
||||
- 实现满足本次 Spec、Change Request 或任务说明。
|
||||
- 相关自动化测试、类型检查、lint、构建或手工验证已经运行,或明确说明无法运行的原因。
|
||||
- 受影响的需求、Spec、Workflow、Domain、ADR、接口契约、安全边界和 Project State 已同步。
|
||||
- 对外或跨团队契约发生变化时,调用方文档和测试说明已同步。
|
||||
- 没有把 Secret、真实客户数据、构建产物、临时文件或无关本地变更纳入交付。
|
||||
|
||||
### 8.3 Change Request
|
||||
|
||||
当一个已 Approved 或 Implemented 的 Spec 发生需求变更时,优先新增或更新 Change Request,而不是把讨论散落到聊天记录中。
|
||||
|
||||
Change Request 至少说明:
|
||||
|
||||
- 变更背景。
|
||||
- 原规则。
|
||||
- 新规则。
|
||||
- 影响范围。
|
||||
- 迁移或兼容策略。
|
||||
- 前端、后端、测试和文档待办。
|
||||
- 验收标准。
|
||||
|
||||
小变更可以直接追加到原 Spec 的“变更记录”章节;跨前后端、权限、安全、数据模型或第三方契约的变更应单独成文。
|
||||
|
||||
### 8.4 Traceability Matrix
|
||||
|
||||
复杂 Feature 应维护需求追踪表,用于连接需求、实现、测试和文档。
|
||||
|
||||
推荐字段:
|
||||
|
||||
| 需求项 | 后端状态 | 前端状态 | 测试状态 | 文档位置 | 当前状态 |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 示例需求 | Pending / Done / N/A | Pending / Done / N/A | Pending / Done / Blocked | Spec / Contract / README | Draft / Approved / Implemented |
|
||||
|
||||
追踪表可以放在 Spec、Project State 或专项 checkpoint 文档中;关键是让新 Agent 能快速判断“文档写了但代码没做、代码做了但文档没写、后端做了但前端没做、前端需要但后端没做”。
|
||||
|
||||
### 8.5 Agent Handoff
|
||||
|
||||
给 AI Agent 分派任务时,建议使用统一交接结构:
|
||||
|
||||
- 背景:为什么做。
|
||||
- 目标:本次必须完成什么。
|
||||
- 边界:本次不做什么。
|
||||
- 必读文档:从入口文档到具体 Spec / Contract。
|
||||
- 影响范围:后端、前端、测试、第三方、数据、权限、安全、审计。
|
||||
- 验收标准:可执行或可观察的检查项。
|
||||
- 允许写操作:是否允许改代码、改文档、造数据、点确认按钮或清理测试数据。
|
||||
- 输出要求:代码位置、测试结果、文档更新清单、风险和下一步建议。
|
||||
|
||||
## 9. AI Working Principles
|
||||
|
||||
- AI 应先理解,再开发。
|
||||
@@ -217,6 +283,7 @@ Documentation Update 属于 Definition of Done,不能跳过。
|
||||
- UI 默认保持一致性,不过度设计。
|
||||
- 代码修改前先确认目标、边界和验收标准。
|
||||
- 涉及接口、安全、权限、数据模型或外部系统时,先读相关契约文档。
|
||||
- 涉及跨 agent 协作时,先确认 Spec、Change Request 或 handoff 是否足够清楚。
|
||||
|
||||
## 10. Documentation Rules
|
||||
|
||||
@@ -230,6 +297,8 @@ Documentation Update 属于 Definition of Done,不能跳过。
|
||||
|
||||
不要维护一个 8000 行的 `DOMAIN.md`。应该按对象拆分成 `Order.md`、`Guest.md`、`Hotel.md`、`Email.md`、`Task.md`。
|
||||
|
||||
通用标准只规定文档职责和流程。具体项目可以新增 Project Overlay,记录本项目专属的需求门禁、核心概念、交付格式和安全边界;Overlay 不应反向污染通用标准。
|
||||
|
||||
## 11. Documentation Update Rules
|
||||
|
||||
完成 Feature 后必须检查:
|
||||
@@ -241,6 +310,8 @@ Documentation Update 属于 Definition of Done,不能跳过。
|
||||
- Spec 是否需要改为 Implemented 或补充结果。
|
||||
- Project State 是否需要更新。
|
||||
- 安全、权限、接口契约是否需要同步。
|
||||
- Traceability Matrix 是否需要更新。
|
||||
- Change Request 是否需要关闭、合并到 Spec 或标记为 Superseded。
|
||||
|
||||
如果没有文档变化,应明确说明:
|
||||
|
||||
@@ -258,6 +329,7 @@ No documentation changes required.
|
||||
AGENTS.md
|
||||
-> CONTEXT.md
|
||||
-> PROJECT_STATE.md
|
||||
-> 项目级 Overlay 或 Adoption 文档
|
||||
-> 相关 Domain
|
||||
-> 相关 Workflow
|
||||
-> 相关 Spec 或 ADR
|
||||
@@ -274,3 +346,5 @@ AI-NSES 不限制编程语言、框架、数据库或 AI 模型。
|
||||
它适用于 Codex、Claude Code、Gemini CLI、Cursor,以及未来任何 AI Agent。
|
||||
|
||||
它描述的是软件工程,不是某个具体工具。
|
||||
|
||||
具体项目如果有更强的安全、合规、业务流程或多 agent 协作要求,应通过项目级 Overlay 补充,不直接把项目私有业务规则写入本通用标准。
|
||||
|
||||
Reference in New Issue
Block a user