aodw-skill 0.7.13 → 0.7.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.aodw-next/01-core/ai-interaction-rules-summary.md +37 -0
- package/.aodw-next/01-core/ai-interaction-rules.md +20 -6
- package/.aodw-next/01-core/ai-knowledge-rules-summary.md +25 -0
- package/.aodw-next/01-core/ai-knowledge-rules.md +19 -21
- package/.aodw-next/01-core/ai-project-overview-rules.md +11 -11
- package/.aodw-next/01-core/aodw-constitution.md +7 -414
- package/.aodw-next/01-core/csf-thinking-framework.md +14 -14
- package/.aodw-next/01-core/git-discipline-summary.md +36 -0
- package/.aodw-next/01-core/git-discipline.md +129 -73
- package/.aodw-next/01-core/module-doc-rules.md +2 -2
- package/.aodw-next/02-workflow/rt-id-generation-rules.md +16 -259
- package/.aodw-next/02-workflow/rt-manager-summary.md +1 -1
- package/.aodw-next/02-workflow/rt-manager.md +73 -344
- package/.aodw-next/02-workflow/spec-full-profile.md +149 -307
- package/.aodw-next/02-workflow/spec-lite-profile.md +170 -253
- package/.aodw-next/02-workflow/ui-workflow-rules-summary.md +39 -0
- package/.aodw-next/02-workflow/ui-workflow-rules.md +57 -292
- package/.aodw-next/03-standards/ai-coding-rules-common.md +1 -1
- package/.aodw-next/03-standards/ai-coding-rules.md +91 -25
- package/.aodw-next/03-standards/stacks/java-springboot/ai-coding-rules-backend.md +9 -9
- package/.aodw-next/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md +13 -13
- package/.aodw-next/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md +10 -10
- package/.aodw-next/03-standards/stacks/rust-axum/ai-coding-rules-backend.md +4 -4
- package/.aodw-next/03-standards/stacks/vue2/ai-coding-rules-frontend.md +9 -9
- package/.aodw-next/04-auditors/aodw-development-auditor-rules.md +15 -10
- package/.aodw-next/04-auditors/aodw-full-auditor-rules.md +14 -14
- package/.aodw-next/04-auditors/aodw-requirement-auditor-rules.md +130 -338
- package/.aodw-next/05-tooling/ai-tools-init-rules.md +74 -367
- package/.aodw-next/06-project/README.md +16 -0
- package/.aodw-next/07-optimization/token-usage-analysis.md +2 -2
- package/.aodw-next/README.md +53 -20
- package/.aodw-next/SKILL.md +32 -0
- package/.aodw-next/config.yaml +2 -2
- package/.aodw-next/manifest.yaml +64 -57
- package/.aodw-next/project.yaml +1 -0
- package/.aodw-next/templates/TEMPLATE-APPLICATION-GUIDE.md +21 -157
- package/.aodw-next/templates/ai-overview.template.md +72 -0
- package/.aodw-next/templates/aodw-kernel-loader-template.md +19 -19
- package/.aodw-next/templates/checklists/coding-standards-template.md +24 -4
- package/.aodw-next/templates/modules-index.template.yaml +13 -0
- package/.aodw-next/templates/plan-lite-template.md +9 -0
- package/.aodw-next/templates/rt-intake-template.md +2 -2
- package/.aodw-next/templates/rt-meta-template.yaml +2 -2
- package/.aodw-next/templates/spec-lite-template.md +9 -0
- package/.aodw-next/templates/tools-config/README.md +1 -1
- package/.aodw-next/templates/tools-config/backend/clippy.config.template.toml +5 -0
- package/.aodw-next/templates/tools-config/backend/rustfmt.config.template.toml +4 -0
- package/.aodw-next/tools-status.yaml +51 -0
- package/AODW_Adapters/antigravity/.agent/rules/aodw-next.md +2 -2
- package/AODW_Adapters/claude/CLAUDE.md +2 -2
- package/AODW_Adapters/cursor/.cursor/rules/aodw-next.mdc +2 -2
- package/AODW_Adapters/gemini/.agent/rules/aodw-next.md +2 -2
- package/AODW_Adapters/gemini/GEMINI.md +6 -5
- package/AODW_Adapters/general/AGENTS.md +2 -2
- package/README.md +62 -45
- package/bin/aodw.js +44 -16
- package/bin/commands/init-overview.js +3 -3
- package/bin/commands/init-tools.js +34 -51
- package/bin/utils/config.js +1 -1
- package/package.json +1 -1
- package/.aodw-next/.aodw-next/01-core/ai-interaction-rules.md +0 -218
- package/.aodw-next/.aodw-next/01-core/ai-knowledge-rules.md +0 -302
- package/.aodw-next/.aodw-next/01-core/ai-project-overview-rules.md +0 -284
- package/.aodw-next/.aodw-next/01-core/aodw-constitution-summary.md +0 -20
- package/.aodw-next/.aodw-next/01-core/aodw-constitution.md +0 -419
- package/.aodw-next/.aodw-next/01-core/csf-thinking-framework.md +0 -373
- package/.aodw-next/.aodw-next/01-core/git-discipline.md +0 -226
- package/.aodw-next/.aodw-next/01-core/module-doc-rules.md +0 -90
- package/.aodw-next/.aodw-next/02-workflow/aodw-development-stages.md +0 -235
- package/.aodw-next/.aodw-next/02-workflow/rt-id-generation-rules.md +0 -267
- package/.aodw-next/.aodw-next/02-workflow/rt-manager-summary.md +0 -15
- package/.aodw-next/.aodw-next/02-workflow/rt-manager.md +0 -399
- package/.aodw-next/.aodw-next/02-workflow/spec-full-profile-summary.md +0 -13
- package/.aodw-next/.aodw-next/02-workflow/spec-full-profile.md +0 -391
- package/.aodw-next/.aodw-next/02-workflow/spec-lite-profile.md +0 -313
- package/.aodw-next/.aodw-next/02-workflow/ui-workflow-rules.md +0 -334
- package/.aodw-next/.aodw-next/03-standards/ai-coding-rules-common.md +0 -89
- package/.aodw-next/.aodw-next/03-standards/ai-coding-rules.md +0 -370
- package/.aodw-next/.aodw-next/03-standards/stacks/java-springboot/ai-coding-rules-backend.md +0 -231
- package/.aodw-next/.aodw-next/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md +0 -612
- package/.aodw-next/.aodw-next/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md +0 -291
- package/.aodw-next/.aodw-next/03-standards/stacks/rust-axum/ai-coding-rules-backend.md +0 -134
- package/.aodw-next/.aodw-next/03-standards/stacks/vue2/ai-coding-rules-frontend.md +0 -220
- package/.aodw-next/.aodw-next/03-standards/ui-kit/ui-kit.md +0 -163
- package/.aodw-next/.aodw-next/04-auditors/aodw-development-auditor-rules.md +0 -470
- package/.aodw-next/.aodw-next/04-auditors/aodw-full-auditor-rules.md +0 -365
- package/.aodw-next/.aodw-next/04-auditors/aodw-requirement-auditor-rules.md +0 -408
- package/.aodw-next/.aodw-next/05-tooling/ai-tools-init-rules.md +0 -676
- package/.aodw-next/.aodw-next/06-project/ai-overview.md +0 -116
- package/.aodw-next/.aodw-next/06-project/modules-index.yaml +0 -11
- package/.aodw-next/.aodw-next/07-optimization/token-usage-analysis.md +0 -253
- package/.aodw-next/.aodw-next/README.md +0 -26
- package/.aodw-next/.aodw-next/RELEASE-CHECKLIST.md +0 -144
- package/.aodw-next/.aodw-next/config.yaml +0 -2
- package/.aodw-next/.aodw-next/manifest.yaml +0 -98
- package/.aodw-next/.aodw-next/templates/SOURCE-TO-DISTRIBUTION-GUIDE.md +0 -276
- package/.aodw-next/.aodw-next/templates/TEMPLATE-APPLICATION-GUIDE.md +0 -246
- package/.aodw-next/.aodw-next/templates/aodw-kernel-loader-template.md +0 -70
- package/.aodw-next/.aodw-next/templates/audit-report-template.md +0 -232
- package/.aodw-next/.aodw-next/templates/changelog-template.md +0 -16
- package/.aodw-next/.aodw-next/templates/checklists/coding-standards-template.md +0 -110
- package/.aodw-next/.aodw-next/templates/csf-review-template.md +0 -201
- package/.aodw-next/.aodw-next/templates/impact-template.md +0 -17
- package/.aodw-next/.aodw-next/templates/invariants-template.md +0 -12
- package/.aodw-next/.aodw-next/templates/module-readme-template.md +0 -39
- package/.aodw-next/.aodw-next/templates/plan-lite-template.md +0 -11
- package/.aodw-next/.aodw-next/templates/rt-decision-template.md +0 -13
- package/.aodw-next/.aodw-next/templates/rt-intake-template.md +0 -33
- package/.aodw-next/.aodw-next/templates/rt-meta-template.yaml +0 -43
- package/.aodw-next/.aodw-next/templates/spec-lite-template.md +0 -17
- package/.aodw-next/.aodw-next/templates/tests-template.md +0 -13
- package/.aodw-next/.aodw-next/templates/tools-config/README.md +0 -112
- package/.aodw-next/.aodw-next/templates/tools-config/backend/black.config.template.toml +0 -6
- package/.aodw-next/.aodw-next/templates/tools-config/backend/pre-commit.config.template.yaml +0 -16
- package/.aodw-next/.aodw-next/templates/tools-config/backend/ruff.config.template.toml +0 -23
- package/.aodw-next/.aodw-next/templates/tools-config/frontend/eslint.config.template.json +0 -113
- package/.aodw-next/.aodw-next/templates/tools-config/frontend/prettier.config.template.json +0 -10
- package/.aodw-next/.aodw-next/templates/tools-config/frontend/tsconfig.paths.template.json +0 -11
- package/.aodw-next/.aodw-next/workflow-guide.md +0 -51
- package/.aodw-next/01-core/aodw-constitution-summary.md +0 -20
- package/.aodw-next/02-workflow/aodw-development-stages.md +0 -235
- package/.aodw-next/02-workflow/spec-full-profile-summary.md +0 -13
- package/.aodw-next/06-project/ai-overview.md +0 -116
- package/.aodw-next/06-project/modules-index.yaml +0 -11
- package/.aodw-next/RELEASE-CHECKLIST.md +0 -144
- package/.aodw-next/templates/SOURCE-TO-DISTRIBUTION-GUIDE.md +0 -276
- package/.aodw-next/workflow-guide.md +0 -51
|
@@ -1,391 +1,233 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
---
|
|
2
|
+
id: aodw-spec-full
|
|
3
|
+
version: 2.0.0
|
|
4
|
+
category: aodw/execution-profile
|
|
5
|
+
trigger: "当 RT-Manager 决策 profile=Spec-Full 时自动加载"
|
|
6
|
+
replaces: "spec-full-profile.md (v1.x,无 Skill 封装版)"
|
|
7
|
+
description: >
|
|
8
|
+
AODW Spec-Full 执行 Skill。适用于复杂功能、高风险改动、多模块变更、数据模型或 API 变更。
|
|
9
|
+
核心变化(v2.0):Skill 化封装,审计器统一调用 aodw-auditor Skill(mode 参数区分阶段)。
|
|
10
|
+
gate_hooks:
|
|
11
|
+
- gate: 1
|
|
12
|
+
name: 需求确认
|
|
13
|
+
action: "展示 spec.md 摘要,等待用户确认"
|
|
14
|
+
- gate: 3
|
|
15
|
+
name: 计划批准
|
|
16
|
+
action: "展示 plan.md 摘要,等待用户批准"
|
|
17
|
+
- gate: 4
|
|
18
|
+
name: 提交确认
|
|
19
|
+
action: "展示 git diff,等待用户确认提交"
|
|
20
|
+
- gate: 5
|
|
21
|
+
name: 完成确认
|
|
22
|
+
action: "提供收尾脚本,等待最终确认"
|
|
23
|
+
token_budget: "~10KB (自身完整流程文档)"
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
# Spec-Full Profile Specification
|
|
3
27
|
|
|
4
|
-
|
|
28
|
+
**适用场景**:新功能、大范围改动、跨模块影响、数据模型或 API 变更、高风险改动。
|
|
5
29
|
|
|
6
|
-
-
|
|
7
|
-
- 涉及多个模块的大范围改动;
|
|
8
|
-
- 涉及数据模型变更;
|
|
9
|
-
- 涉及外部 API / 协议变更;
|
|
10
|
-
- 涉及性能 / 安全 / 合规性的重要特性;
|
|
11
|
-
- 大规模重构。
|
|
30
|
+
**不适用场景**:Bug 修复、单模块小改进、UI 微调(应使用 Spec-Lite)。
|
|
12
31
|
|
|
13
32
|
---
|
|
14
33
|
|
|
15
34
|
## 1. 文件结构
|
|
16
35
|
|
|
17
|
-
在 `RT/RT-XXX/`
|
|
36
|
+
在 `RT/RT-XXX/` 目录下:
|
|
18
37
|
|
|
19
|
-
```
|
|
38
|
+
```
|
|
20
39
|
RT/RT-XXX/
|
|
21
40
|
spec.md ← 完整需求说明
|
|
22
41
|
plan.md ← 技术实现方案
|
|
23
42
|
data-model.md ← 实体与关系
|
|
24
|
-
contracts/ ← API / 消息 / 数据契约
|
|
25
|
-
research.md ← 调研与决策记录(如需要)
|
|
26
|
-
tasks.md ← 按 User Story 和 Phase 拆分的实现任务
|
|
27
|
-
checklists/ ← 质量检查清单
|
|
28
43
|
impact.md ← 影响分析
|
|
29
|
-
|
|
30
|
-
tests.md ← 测试点
|
|
44
|
+
tests.md ← 验证计划
|
|
31
45
|
changelog.md ← 行为变更总结
|
|
32
46
|
```
|
|
33
47
|
|
|
34
48
|
---
|
|
35
49
|
|
|
36
|
-
## 2.
|
|
37
|
-
|
|
38
|
-
`spec.md` 由 AI 根据用户描述和澄清问题自动生成,典型结构:
|
|
39
|
-
|
|
40
|
-
```markdown
|
|
41
|
-
# Spec: RT-XXX - <feature name>
|
|
42
|
-
|
|
43
|
-
## 1. 背景与动机(Background & Motivation)
|
|
44
|
-
- 为什么需要这个特性 / 改动?
|
|
45
|
-
|
|
46
|
-
## 2. 目标与非目标(Goals / Non-goals)
|
|
47
|
-
- 明确列出本 RT 的目标范围;
|
|
48
|
-
- 明确哪些是本次不处理的内容。
|
|
49
|
-
|
|
50
|
-
## 3. 用户故事 / 用例(User Stories)
|
|
51
|
-
- 角色、目标、场景;
|
|
52
|
-
- 主路径与备选路径。
|
|
53
|
-
|
|
54
|
-
## 4. 功能需求(Functional Requirements)
|
|
55
|
-
- 用编号列出可验证的需求。
|
|
56
|
-
|
|
57
|
-
## 5. 非功能需求(Non-functional Requirements)
|
|
58
|
-
- 性能、可用性、可靠性、安全性等。
|
|
50
|
+
## 2. 流程概览
|
|
59
51
|
|
|
60
|
-
## 6. 假设与依赖(Assumptions & Dependencies)
|
|
61
|
-
- 对外部系统 / 团队 / 前置条件的假设。
|
|
62
|
-
|
|
63
|
-
## 7. 成功标准(Success Criteria)
|
|
64
|
-
- 如何判断本 RT 成功完成。
|
|
65
|
-
|
|
66
|
-
## 8. 澄清记录(Clarifications)
|
|
67
|
-
- Question / Answer 列表(来自 AI 主动提问与用户回答)。
|
|
68
52
|
```
|
|
69
|
-
|
|
70
|
-
|
|
53
|
+
Intake → Spec/Plan (AI 生成) → 计划批准 → 实现 → 审计 → 验证 → 完成 → Git 提交
|
|
54
|
+
```
|
|
71
55
|
|
|
72
56
|
---
|
|
73
57
|
|
|
74
|
-
## 3.
|
|
75
|
-
|
|
76
|
-
AI 应对模糊或高影响问题提出有限数量(通常≤5)的澄清问题:
|
|
58
|
+
## 3. 核心 Spec (spec.md)
|
|
77
59
|
|
|
78
|
-
|
|
79
|
-
- 用户选择后,将问答记录到 `spec.md` 的 Clarifications 部分;
|
|
80
|
-
- 同时更新相关需求段落,使 spec 不再依赖上下文对话。
|
|
60
|
+
AI 根据用户描述和澄清问题自动生成,必须包含:
|
|
81
61
|
|
|
82
|
-
|
|
62
|
+
### 3.1 背景与动机
|
|
63
|
+
- 为什么需要这个特性
|
|
64
|
+
- 业务目标是什么
|
|
83
65
|
|
|
84
|
-
|
|
66
|
+
### 3.2 目标与非目标
|
|
67
|
+
- 明确列出本次 RT 的目标范围
|
|
68
|
+
- 明确哪些是**不处理**的内容
|
|
85
69
|
|
|
86
|
-
|
|
70
|
+
### 3.3 技术约束
|
|
71
|
+
- 性能要求
|
|
72
|
+
- 兼容性要求
|
|
73
|
+
- 安全要求
|
|
87
74
|
|
|
88
|
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
- 如果发现阻断性问题,**必须停止流程**,要求用户修复
|
|
93
|
-
|
|
94
|
-
**审计重点**:
|
|
95
|
-
- 需求完整性:文档结构是否完整、目标是否明确、需求是否可验证
|
|
96
|
-
- 需求一致性:与 `intake.md` 是否一致
|
|
97
|
-
- 需求可执行性:技术方案是否足够详细
|
|
98
|
-
|
|
99
|
-
**详细规范**:详见 `.aodw/04-auditors/aodw-requirement-auditor-rules.md`
|
|
75
|
+
### 3.4 验收标准
|
|
76
|
+
- 功能验收标准
|
|
77
|
+
- 代码质量验收标准
|
|
78
|
+
- 测试覆盖率要求
|
|
100
79
|
|
|
101
80
|
---
|
|
102
81
|
|
|
103
|
-
##
|
|
104
|
-
|
|
105
|
-
在 Spec 阶段完成后,建议执行 CSF 审查(详见 `.aodw/01-core/csf-thinking-framework.md`):
|
|
82
|
+
## 4. 技术方案 (plan.md)
|
|
106
83
|
|
|
107
|
-
|
|
108
|
-
- **输出**:`RT/RT-XXX/csf-review.md`(如执行)
|
|
109
|
-
- **触发**:用户要求或 AI 判断需要时
|
|
84
|
+
AI 生成的技术实现方案,必须包含:
|
|
110
85
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
86
|
+
### 4.1 技术选择
|
|
87
|
+
- 使用的框架、库、工具
|
|
88
|
+
- 技术选择的理由
|
|
114
89
|
|
|
115
|
-
|
|
90
|
+
### 4.2 架构设计
|
|
91
|
+
- 组件关系图(可选,用 Mermaid 或 ASCII)
|
|
92
|
+
- 分层设计
|
|
93
|
+
- 数据流设计
|
|
116
94
|
|
|
117
|
-
### 4.
|
|
95
|
+
### 4.3 实现步骤
|
|
96
|
+
按优先级排列的具体步骤
|
|
97
|
+
- 每个步骤包含:子任务、负责人(可选)、预计时间
|
|
118
98
|
|
|
119
|
-
|
|
99
|
+
### 4.5 数据模型变更(如涉及)
|
|
100
|
+
- Schema 变更说明
|
|
101
|
+
- 迁移策略
|
|
120
102
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
- **必须**在 `RT/RT-XXX/docs/ui-prototype.html` 创建 HTML 原型文件
|
|
126
|
-
- 生成完整的静态 HTML 原型(使用模拟数据)
|
|
127
|
-
- 必须包含所有 UI 元素和交互状态
|
|
128
|
-
- 必须包含完整样式,可在浏览器中直接打开查看
|
|
129
|
-
4. **用户确认步骤(强制门禁)**:
|
|
130
|
-
- **必须**等待用户在浏览器中查看原型并明确确认
|
|
131
|
-
- **严禁**在未获得用户确认前进入实现阶段
|
|
132
|
-
5. **UI 审查步骤**:执行 UI 质量审查
|
|
133
|
-
6. **UI 实现步骤**:用户确认后生成实现代码
|
|
134
|
-
|
|
135
|
-
> ⚠️ **关键要求**:HTML 原型创建和用户确认是**强制步骤**,不可跳过。详细规则请参考 `.aodw/02-workflow/ui-workflow-rules.md`
|
|
103
|
+
### 4.6 API 变更(如涉及)
|
|
104
|
+
- 新增端点
|
|
105
|
+
- 修改的端点
|
|
106
|
+
- 废弃的端点
|
|
136
107
|
|
|
137
108
|
---
|
|
138
109
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
`plan.md` 描述"如何实现":
|
|
142
|
-
|
|
143
|
-
```markdown
|
|
144
|
-
# Plan: RT-XXX - <feature name>
|
|
145
|
-
|
|
146
|
-
## 1. 技术背景
|
|
147
|
-
- 当前系统相关部分的技术状况。
|
|
148
|
-
|
|
149
|
-
## 2. 方案概览
|
|
150
|
-
- 整体思路与关键设计决策。
|
|
151
|
-
|
|
152
|
-
## 3. 组件与模块变更
|
|
153
|
-
- 哪些模块会被修改 / 新增 / 删除。
|
|
154
|
-
|
|
155
|
-
## 4. 代码结构与分层设计(必须)
|
|
156
|
-
|
|
157
|
-
> **注意**:本节必须根据项目编码规范(`.aodw/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md` 或 `.aodw/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md`)进行设计。
|
|
158
|
-
|
|
159
|
-
### 4.1 前端代码结构(如涉及)
|
|
160
|
-
- **使用的页面**:`src/pages/<PageName>/`
|
|
161
|
-
- **新增 features 模块**(如需要):`src/features/<domain>/`
|
|
162
|
-
- **组件拆分**:
|
|
163
|
-
- `ComponentName.tsx`(职责说明)
|
|
164
|
-
- `AnotherComponent.tsx`(职责说明)
|
|
165
|
-
- **Hooks**:`useHookName.ts`(职责说明)
|
|
166
|
-
- **Store**:`storeName.store.ts`(职责说明)
|
|
167
|
-
- **目录结构示例**:
|
|
168
|
-
```
|
|
169
|
-
src/pages/ProjectEditorPage/
|
|
170
|
-
├── index.tsx # 页面入口
|
|
171
|
-
├── Header.tsx # 页面头部
|
|
172
|
-
├── Sidebar.tsx # 侧边栏
|
|
173
|
-
├── Canvas.tsx # 画布
|
|
174
|
-
├── hooks/ # 页面专用 hooks
|
|
175
|
-
│ └── useProjectEditor.ts
|
|
176
|
-
└── store/ # 页面专用 store
|
|
177
|
-
└── projectEditor.store.ts
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
### 4.2 后端代码结构(如涉及)
|
|
181
|
-
- **API 路由**:`app/api/v1/<resource>.py`
|
|
182
|
-
- **Service**:`app/services/<resource>_service.py`
|
|
183
|
-
- **Repository**:`app/repositories/<resource>_repository.py`
|
|
184
|
-
- **Schema**:`app/schemas/<resource>_schema.py`
|
|
185
|
-
- **分层职责说明**:
|
|
186
|
-
- API 层:接收请求,参数校验,调用 Service
|
|
187
|
-
- Service 层:业务逻辑处理,调用 Repository
|
|
188
|
-
- Repository 层:数据访问,数据库操作
|
|
189
|
-
- **目录结构示例**:
|
|
190
|
-
```
|
|
191
|
-
app/
|
|
192
|
-
├── api/v1/
|
|
193
|
-
│ └── project.py # API 路由
|
|
194
|
-
├── services/
|
|
195
|
-
│ └── project_service.py # 业务逻辑
|
|
196
|
-
├── repositories/
|
|
197
|
-
│ └── project_repository.py # 数据访问
|
|
198
|
-
└── schemas/
|
|
199
|
-
└── project_schema.py # 数据模型
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### 4.3 编码规范符合性说明
|
|
203
|
-
- **前端**(如涉及):
|
|
204
|
-
- [ ] 目录结构符合规范(pages / features / shared)
|
|
205
|
-
- [ ] 组件拆分符合规范(单一职责、适度复用)
|
|
206
|
-
- [ ] 文件大小符合规范(页面 ≤ 300 行,组件 ≤ 200 行)
|
|
207
|
-
- **后端**(如涉及):
|
|
208
|
-
- [ ] 分层架构符合规范(api → services → repositories)
|
|
209
|
-
- [ ] 文件大小符合规范(模块 ≤ 300 行,函数 ≤ 60 行)
|
|
210
|
-
- [ ] 依赖关系符合规范(不跨层调用)
|
|
211
|
-
|
|
212
|
-
## 5. 数据流与控制流
|
|
213
|
-
- 请求如何在系统内部流转。
|
|
214
|
-
|
|
215
|
-
## 6. 风险与缓解策略
|
|
216
|
-
- 潜在问题及对应的缓解方案。
|
|
217
|
-
|
|
218
|
-
## 7. 分阶段计划
|
|
219
|
-
- 如果需要分多个阶段实现,说明每阶段目标。
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
### 4.2 research.md(可选)
|
|
223
|
-
|
|
224
|
-
若需要对比多种实现方案、技术栈或第三方服务,可在 `research.md` 中记录:
|
|
225
|
-
|
|
226
|
-
- 备选方案;
|
|
227
|
-
- 评估维度(性能、成本、复杂度等);
|
|
228
|
-
- 最终选择与理由。
|
|
229
|
-
|
|
230
|
-
### 4.3 data-model.md
|
|
231
|
-
|
|
232
|
-
记录本 RT 相关的实体 / 关系 / 字段变更:
|
|
233
|
-
|
|
234
|
-
- 新增实体;
|
|
235
|
-
- 字段语义变更;
|
|
236
|
-
- 关系调整。
|
|
237
|
-
|
|
238
|
-
### 4.4 contracts/
|
|
239
|
-
|
|
240
|
-
记录对外契约:
|
|
241
|
-
|
|
242
|
-
- REST / GraphQL / gRPC API;
|
|
243
|
-
- 消息格式、事件结构;
|
|
244
|
-
- 文件格式等。
|
|
110
|
+
## 5. 影响分析 (impact.md)
|
|
245
111
|
|
|
246
|
-
|
|
112
|
+
必须分析对现有功能的影响,包括:
|
|
247
113
|
|
|
248
|
-
|
|
114
|
+
### 5.1 兼容性影响
|
|
115
|
+
- 向后兼容的保证
|
|
116
|
+
- 迁移需求
|
|
249
117
|
|
|
250
|
-
|
|
251
|
-
-
|
|
252
|
-
-
|
|
253
|
-
- 审计结果记录在 `RT/RT-XXX/requirement-audit-report.md`
|
|
254
|
-
- 如果发现阻断性问题,**必须停止流程**,要求用户修复
|
|
118
|
+
### 5.2 性能影响
|
|
119
|
+
- 预期性能变化
|
|
120
|
+
- 优化措施
|
|
255
121
|
|
|
256
|
-
|
|
257
|
-
-
|
|
258
|
-
-
|
|
259
|
-
- 需求可执行性:代码结构与分层设计是否明确、是否符合编码规范
|
|
260
|
-
- **战略对齐与 CSF 检查**(自动包含):
|
|
261
|
-
- 以终为始:验证方案是否直接贡献于目标
|
|
262
|
-
- 结构化分解:验证方案分解是否 MECE
|
|
263
|
-
- 关键要素识别:识别影响目标达成的 CSF
|
|
264
|
-
- 流程与系统观:检查端到端关键路径
|
|
265
|
-
- 多维决策:评估技术方案的合理性(至少 2-3 个备选方案)
|
|
122
|
+
### 5.3 安全影响
|
|
123
|
+
- 安全风险评估
|
|
124
|
+
- 缓解措施
|
|
266
125
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
- 需求阶段审计官自动包含 CSF 审查,因此不需要单独执行 CSF 审查
|
|
271
|
-
- 如果用户希望获得建设性的 CSF 审查建议,可以单独执行 CSF Review(输出到 `csf-review.md`)
|
|
126
|
+
### 5.4 依赖影响
|
|
127
|
+
- 第三方依赖的变更
|
|
128
|
+
- 内部模块的依赖变更
|
|
272
129
|
|
|
273
130
|
---
|
|
274
131
|
|
|
275
|
-
##
|
|
276
|
-
|
|
277
|
-
### 5.1 tasks.md
|
|
278
|
-
|
|
279
|
-
以严格的 checklist 格式列出实现步骤:
|
|
280
|
-
|
|
281
|
-
```markdown
|
|
282
|
-
- [ ] T001 [US1] 在后端添加 X 实体的存储逻辑(apps/api/src/...)
|
|
283
|
-
- [ ] T002 [US1] 为 X 实体添加 API 路由(apps/api/src/...)
|
|
284
|
-
- [ ] T003 [US1] 在前端页面展示 X 列表(apps/web/src/...)
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
- 可以使用 [P] 标记可并行的任务;
|
|
288
|
-
- 任务应按 Phase 编组,使每一阶段都能形成可验证的增量成果。
|
|
132
|
+
## 6. 测试计划 (tests.md)
|
|
289
133
|
|
|
290
|
-
|
|
134
|
+
验证规格和方案是否实现正确:
|
|
291
135
|
|
|
292
|
-
|
|
136
|
+
### 6.1 单元测试
|
|
137
|
+
- 新代码必须有单元测试
|
|
138
|
+
- 测试覆盖率要求
|
|
293
139
|
|
|
294
|
-
|
|
295
|
-
-
|
|
296
|
-
-
|
|
297
|
-
- security.md:安全要求是否明确、是否有相应对策;
|
|
298
|
-
- performance.md:性能目标是否量化、是否有测量方案。
|
|
140
|
+
### 6.2 集成测试
|
|
141
|
+
- API 集成测试
|
|
142
|
+
- 端到端测试
|
|
299
143
|
|
|
300
|
-
|
|
144
|
+
### 6.3 手动测试场景
|
|
145
|
+
- 关键用户路径测试
|
|
146
|
+
- 边界条件测试
|
|
301
147
|
|
|
302
148
|
---
|
|
303
149
|
|
|
304
|
-
##
|
|
305
|
-
|
|
306
|
-
### 6.1 开发准备(Dev Ready)
|
|
307
|
-
|
|
308
|
-
在开始编码前,AI 必须确认:
|
|
150
|
+
## 7. 行为变更总结 (changelog.md)
|
|
309
151
|
|
|
310
|
-
|
|
311
|
-
- [ ] **编码规范已加载**:
|
|
312
|
-
- [ ] 如果涉及前端:已读取 `.aodw/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md`
|
|
313
|
-
- [ ] 如果涉及后端:已读取 `.aodw/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md`
|
|
314
|
-
- [ ] 已读取 `.aodw/03-standards/ai-coding-rules-common.md`(通用规范)
|
|
152
|
+
记录本次 RT 的所有变更,格式:
|
|
315
153
|
|
|
316
|
-
###
|
|
154
|
+
### 7.1 功能变更
|
|
155
|
+
- 新增功能
|
|
156
|
+
- 功能改进
|
|
317
157
|
|
|
318
|
-
|
|
319
|
-
-
|
|
320
|
-
-
|
|
158
|
+
### 7.2 Bug 修复
|
|
159
|
+
- 修复的 Bug 编号
|
|
160
|
+
- 修复描述
|
|
321
161
|
|
|
322
|
-
###
|
|
162
|
+
### 7.3 代码重构
|
|
163
|
+
- 重构的模块
|
|
164
|
+
- 重构原因
|
|
323
165
|
|
|
324
|
-
|
|
166
|
+
### 7.4 配置变更
|
|
167
|
+
- 配置文件变更
|
|
168
|
+
- 环境变量变更
|
|
325
169
|
|
|
326
|
-
|
|
327
|
-
- 前端:`npm run lint` 或 `npx eslint .`
|
|
328
|
-
- 后端:`ruff check .`
|
|
329
|
-
- [ ] **运行格式化检查**:
|
|
330
|
-
- 前端:`npm run format` 或 `npx prettier --write .`
|
|
331
|
-
- 后端:`black .`
|
|
332
|
-
- [ ] **文件大小和复杂度符合规范**(参考 `.aodw/03-standards/ai-coding-rules-common.md`)
|
|
170
|
+
---
|
|
333
171
|
|
|
334
|
-
|
|
172
|
+
## 8. 不可破坏边界 (invariants.md)
|
|
335
173
|
|
|
336
|
-
|
|
174
|
+
必须明确不可破坏的原则和边界:
|
|
337
175
|
|
|
338
|
-
|
|
339
|
-
-
|
|
340
|
-
-
|
|
341
|
-
- 审计结果记录在 `RT/RT-XXX/development-audit-report.md`
|
|
342
|
-
- 如果发现阻断性问题,**必须停止流程**,要求用户修复
|
|
176
|
+
### 8.1 API 契约
|
|
177
|
+
- 不得破坏现有 API 契约
|
|
178
|
+
- 向后兼容的保证
|
|
343
179
|
|
|
344
|
-
|
|
345
|
-
-
|
|
346
|
-
-
|
|
347
|
-
- 架构合规性:分层架构、依赖管理
|
|
348
|
-
- 知识维护:文档与代码一致性、知识蒸馏
|
|
180
|
+
### 8.2 数据完整性
|
|
181
|
+
- 不得破坏数据完整性
|
|
182
|
+
- 迁移过程中的数据保护
|
|
349
183
|
|
|
350
|
-
|
|
184
|
+
### 8.3 性能指标
|
|
185
|
+
- 不得降低关键性能指标
|
|
186
|
+
- 性能回退策略
|
|
351
187
|
|
|
352
188
|
---
|
|
353
189
|
|
|
354
|
-
##
|
|
190
|
+
## 9. Gate 检查点
|
|
355
191
|
|
|
356
|
-
|
|
192
|
+
必须在以下 Gate 等待用户确认:
|
|
357
193
|
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
194
|
+
| Gate | 检查点 | 行动 |
|
|
195
|
+
|------|---------|------|
|
|
196
|
+
| 1 | 需求确认 | 展示 spec.md 摘要 |
|
|
197
|
+
| 2 | 计划批准 | 展示 plan.md 摘要 |
|
|
198
|
+
| 3 | 实现 | AI 验证实现完成 |
|
|
199
|
+
| 4 | 审计 | 运行 aodw-auditor mode=requirement |
|
|
200
|
+
| 5 | 验证 | 运行测试 |
|
|
201
|
+
| 6 | 完成 | 提供收尾脚本 |
|
|
362
202
|
|
|
363
203
|
---
|
|
364
204
|
|
|
365
|
-
##
|
|
205
|
+
## 10. 审计要求
|
|
366
206
|
|
|
367
|
-
|
|
368
|
-
- Spec
|
|
369
|
-
-
|
|
207
|
+
**必须审计**(使用 `aodw-requirement-auditor-rules.md`):
|
|
208
|
+
- Spec 完整性
|
|
209
|
+
- Plan 可行性
|
|
210
|
+
- Impact 分析充分性
|
|
370
211
|
|
|
371
|
-
|
|
372
|
-
|
|
212
|
+
**必须通过审计后才能**:
|
|
213
|
+
- 开始代码实现
|
|
214
|
+
- 提交到 feature 分支
|
|
373
215
|
|
|
374
216
|
---
|
|
375
217
|
|
|
376
|
-
##
|
|
218
|
+
## 11. 文档同步
|
|
377
219
|
|
|
378
|
-
|
|
220
|
+
完成后必须:
|
|
221
|
+
- 更新模块索引(`modules-index.yaml`)
|
|
222
|
+
- 更新相关模块 README
|
|
223
|
+
- 记录新 API 到文档
|
|
379
224
|
|
|
380
|
-
|
|
381
|
-
- 涉及对外 API 变动;
|
|
382
|
-
- 与 invariants 无法同时满足;
|
|
225
|
+
---
|
|
383
226
|
|
|
384
|
-
|
|
227
|
+
## 12. 引用规范
|
|
385
228
|
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
229
|
+
必须与以下规范配合:
|
|
230
|
+
- `aodw-next/03-standards/ai-coding-rules.md`(编码规范)
|
|
231
|
+
- `aodw-next/01-core/git-discipline.md`(Git 规范)
|
|
232
|
+
- 对应技术栈的编码规范文件
|
|
390
233
|
|
|
391
|
-
升级过程应在 `changelog.md` 中明确记录。
|