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,302 +0,0 @@
|
|
|
1
|
-
# AI Knowledge Maintenance Rules
|
|
2
|
-
AI 必须确保文档始终与代码一致。
|
|
3
|
-
|
|
4
|
-
本文件定义“何时更新哪些文档”,以及文档与代码之间的映射方式。
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 1. 总原则
|
|
9
|
-
|
|
10
|
-
1. 文档是系统的一等公民,必须与代码一起演化;
|
|
11
|
-
2. 任何重要改动都必须在相关文档中有所体现;
|
|
12
|
-
3. AI 在执行任何非琐碎修改后,应主动检查并更新相关文档;
|
|
13
|
-
4. 如果文档与代码不一致,AI 应优先尝试修正不一致,而不是忽略。
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## 2. 文档类别
|
|
18
|
-
|
|
19
|
-
### 2.1 全局文档(Global)
|
|
20
|
-
|
|
21
|
-
位于 `.aodw/` 或 `docs/` 下,用于整个系统:
|
|
22
|
-
|
|
23
|
-
- `.aodw/01-core/aodw-constitution.md`
|
|
24
|
-
- `.aodw/06-project/ai-overview.md`
|
|
25
|
-
- `.aodw/03-standards/ai-coding-rules.md`
|
|
26
|
-
- `.aodw/01-core/ai-knowledge-rules.md`
|
|
27
|
-
- 模块 README(如 `docs/modules/users.md`、`docs/modules/orders.md` 等)
|
|
28
|
-
- 数据与合约文档(如 `data-model.md`、`contracts/*.md` / `contracts/*.yaml`)
|
|
29
|
-
|
|
30
|
-
**当发生以下情况时,AI 必须更新相关全局文档:**
|
|
31
|
-
|
|
32
|
-
- 整体架构变化(例如引入新子系统、拆分服务、替换核心中间件);
|
|
33
|
-
- 模块职责变化(例如将一部分业务从 A 模块迁移到 B 模块);
|
|
34
|
-
- 数据模型变化(增加 / 删除 / 修改实体或字段含义);
|
|
35
|
-
- 对外接口或协议变化(API、消息格式等);
|
|
36
|
-
- AODW 流程规则本身发生修改。
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
### 2.2 RT 专属文档(Local per RT)
|
|
41
|
-
|
|
42
|
-
每个 RT 都有自己的知识库目录,包括核心文档和过程文档。
|
|
43
|
-
|
|
44
|
-
**目录结构**:详见 `.aodw/02-workflow/rt-manager.md` 第 2 节"目录与分支创建"。
|
|
45
|
-
|
|
46
|
-
**核心文档**:位于 RT 目录根目录,记录 RT 全生命周期信息(intake、decision、spec、plan、impact、invariants、tests、changelog 等)。
|
|
47
|
-
|
|
48
|
-
**过程文档**:位于 `RT/RT-XXX/docs/` 目录,记录执行过程中的分析、调研、决策。详细规则见第 7 节。
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
## 3. 何时更新哪些文档
|
|
53
|
-
|
|
54
|
-
### 3.1 Intake 阶段后
|
|
55
|
-
|
|
56
|
-
在 RT-Manager 完成本 RT 的 Intake(立项)后:
|
|
57
|
-
|
|
58
|
-
- 必须创建 / 更新:
|
|
59
|
-
- `RT/RT-XXX/intake.md`
|
|
60
|
-
- `RT/RT-XXX/decision.md`
|
|
61
|
-
|
|
62
|
-
`intake.md` 应包含:
|
|
63
|
-
|
|
64
|
-
- 原始用户描述;
|
|
65
|
-
- AI 提出的问题与用户回答的简要记录;
|
|
66
|
-
- 对需求 / 问题的归类(Feature / Bug / Enhancement / Refactor / Research 等);
|
|
67
|
-
- 初步范围与风险评估。
|
|
68
|
-
|
|
69
|
-
`decision.md` 应包含:
|
|
70
|
-
|
|
71
|
-
- 为何选择 Spec-Full 或 Spec-Lite;
|
|
72
|
-
- 若存在备选流程(如纯 Research),记录为何未采用;
|
|
73
|
-
- 如用户强行指定流程,记录 AI 的原始建议与用户的选择。
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
### 3.2 Spec 阶段后(Spec-Full / Spec-Lite)
|
|
78
|
-
|
|
79
|
-
**Spec-Full:**
|
|
80
|
-
|
|
81
|
-
- AI 必须创建 / 更新:
|
|
82
|
-
- `RT/RT-XXX/spec.md`
|
|
83
|
-
- `RT/RT-XXX/clarifications`(可在 spec 中以章节形式存在)
|
|
84
|
-
|
|
85
|
-
Spec 内容应包括:
|
|
86
|
-
|
|
87
|
-
- 背景与目标;
|
|
88
|
-
- 用户故事 / 功能需求;
|
|
89
|
-
- 非功能需求(性能、安全、可用性等);
|
|
90
|
-
- 成功标准;
|
|
91
|
-
- 需要澄清的历史问题记录(Q&A)。
|
|
92
|
-
|
|
93
|
-
**Spec-Lite:**
|
|
94
|
-
|
|
95
|
-
- AI 必须创建 / 更新:
|
|
96
|
-
- `RT/RT-XXX/spec-lite.md`
|
|
97
|
-
|
|
98
|
-
Spec-Lite 内容应精简,至少包含:
|
|
99
|
-
|
|
100
|
-
- 当前问题描述;
|
|
101
|
-
- 目标行为(修复后 / 改进后的预期效果);
|
|
102
|
-
- 影响范围的文字说明。
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
### 3.3 Plan 阶段后
|
|
107
|
-
|
|
108
|
-
**Spec-Full:**
|
|
109
|
-
|
|
110
|
-
- AI 必须创建 / 更新:
|
|
111
|
-
- `RT/RT-XXX/plan.md`
|
|
112
|
-
- `RT/RT-XXX/data-model.md`(如涉及数据模型变更)
|
|
113
|
-
- `RT/RT-XXX/contracts/`(如涉及对外接口变更)
|
|
114
|
-
- `RT/RT-XXX/research.md`(如有前期调研与决策)
|
|
115
|
-
|
|
116
|
-
**Spec-Lite:**
|
|
117
|
-
|
|
118
|
-
- AI 必须创建 / 更新:
|
|
119
|
-
- `RT/RT-XXX/plan-lite.md`
|
|
120
|
-
|
|
121
|
-
Plan-Lite 内容应包含:
|
|
122
|
-
|
|
123
|
-
- 预期修改的代码位置(文件路径 / 模块);
|
|
124
|
-
- 简单的技术方案;
|
|
125
|
-
- 潜在风险与注意事项。
|
|
126
|
-
|
|
127
|
-
---
|
|
128
|
-
|
|
129
|
-
### 3.4 修改代码前
|
|
130
|
-
|
|
131
|
-
在实现前,AI 必须创建 / 更新:
|
|
132
|
-
|
|
133
|
-
- `RT/RT-XXX/impact.md`
|
|
134
|
-
- 当前问题是如何触发的;
|
|
135
|
-
- 哪些模块 / 功能直接受到影响;
|
|
136
|
-
- 哪些模块可能被间接影响;
|
|
137
|
-
- `RT/RT-XXX/invariants.md`
|
|
138
|
-
- 在本次改动中必须保持不变的行为;
|
|
139
|
-
- 不允许被破坏的数据与接口约束。
|
|
140
|
-
|
|
141
|
-
这些文档是 **变更的约束条件**。如之后发现方案与 invariants 冲突,AI 应向用户明确指出,并建议走 Spec-Full 或修订 invariants。
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
|
|
145
|
-
### 3.5 修改代码后
|
|
146
|
-
|
|
147
|
-
在实现完成后,AI 必须:
|
|
148
|
-
|
|
149
|
-
1. **更新 tests.md**
|
|
150
|
-
|
|
151
|
-
- 列出新增的测试用例及其覆盖的场景;
|
|
152
|
-
- 列出建议回归的关键用例;
|
|
153
|
-
- 如存在未自动化但应进行手动验证的场景,也应列出。
|
|
154
|
-
|
|
155
|
-
2. **更新 changelog.md**
|
|
156
|
-
|
|
157
|
-
- 以简洁的方式概述本次 RT 对系统行为的改动;
|
|
158
|
-
- 如有潜在影响范围(例如“可能对历史数据产生影响”),加以说明;
|
|
159
|
-
- 标注与其他 RT 或模块的依赖关系。
|
|
160
|
-
|
|
161
|
-
3. 如涉及数据模型或对外接口更改,必须更新:
|
|
162
|
-
|
|
163
|
-
- `data-model.md`;
|
|
164
|
-
- `contracts/` 中的相关说明;
|
|
165
|
-
- 相关模块 README;
|
|
166
|
-
- 必要时更新 `ai-overview.md`(例如新增了新的核心模块)。
|
|
167
|
-
|
|
168
|
-
---
|
|
169
|
-
|
|
170
|
-
## 4. 文档与代码的映射(Frontmatter Mapping)
|
|
171
|
-
|
|
172
|
-
为了帮助 AI 找到与某段代码相关的文档,建议在文档顶部使用 Frontmatter:
|
|
173
|
-
|
|
174
|
-
```yaml
|
|
175
|
-
---
|
|
176
|
-
rt: RT-001
|
|
177
|
-
related_files:
|
|
178
|
-
- apps/api/src/orders/**
|
|
179
|
-
- apps/api/src/orders/order_service.ts
|
|
180
|
-
- apps/web/src/features/orders/**
|
|
181
|
-
---
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
或在模块 README 中:
|
|
185
|
-
|
|
186
|
-
```yaml
|
|
187
|
-
---
|
|
188
|
-
module: orders
|
|
189
|
-
files:
|
|
190
|
-
- apps/api/src/orders/**
|
|
191
|
-
- apps/web/src/features/orders/**
|
|
192
|
-
---
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
AI 在进行修改时,必须执行 **Mapping Check**:
|
|
196
|
-
|
|
197
|
-
1. **查索引**:读取 `.aodw/06-project/modules-index.yaml`,获取所有模块的 `root` 路径。
|
|
198
|
-
2. **匹配路径**:检查本次修改的文件路径是否落在某个模块的 `root` 下。
|
|
199
|
-
3. **定位文档**:如果匹配,读取对应的 `path`(即模块 README)。
|
|
200
|
-
4. **验证 Frontmatter**:进一步检查模块 README 中的 `files` 字段是否包含该文件。
|
|
201
|
-
5. **更新文档**:确认匹配后,必须审查该文档,并将本次 RT 的变更同步更新进去。
|
|
202
|
-
|
|
203
|
-
**如果找不到匹配的模块**:
|
|
204
|
-
- 考虑是否需要创建一个新模块?
|
|
205
|
-
- 或者该文件属于公共基础设施(需更新全局文档)?
|
|
206
|
-
|
|
207
|
-
---
|
|
208
|
-
|
|
209
|
-
## 5. 文档一致性检查
|
|
210
|
-
|
|
211
|
-
在 RT 实现流程的最后(合并 / 完成之前),AI 应进行一次快速一致性检查:
|
|
212
|
-
|
|
213
|
-
**核心文档检查**:
|
|
214
|
-
- 当前改动是否改变了数据模型?如果是,`data-model.md` 是否反映了这一点?
|
|
215
|
-
- 当前改动是否改变了对外接口?如果是,`contracts/` 是否已更新?
|
|
216
|
-
- 当前改动是否改变了模块职责?如果是,相关 README 是否已更新?
|
|
217
|
-
- 当前 RT 的:
|
|
218
|
-
- `spec` / `spec-lite`
|
|
219
|
-
- `plan` / `plan-lite`
|
|
220
|
-
- `impact`
|
|
221
|
-
- `invariants`
|
|
222
|
-
- `tests`
|
|
223
|
-
- `changelog`
|
|
224
|
-
|
|
225
|
-
是否完整地记录了从"问题 → 方案 → 实现 → 测试 → 结果"的过程?
|
|
226
|
-
|
|
227
|
-
**目录结构检查**:
|
|
228
|
-
- 检查过程文档是否在正确位置(应在 `RT/RT-XXX/docs/` 目录下,详见第 7 节)
|
|
229
|
-
- 检查核心文档是否完整(meta.yaml、intake.md、decision.md、spec/plan、impact、invariants、tests、changelog)
|
|
230
|
-
|
|
231
|
-
如发现明显不一致,AI 应主动修订文档或提示用户。
|
|
232
|
-
|
|
233
|
-
---
|
|
234
|
-
|
|
235
|
-
## 6. 版本控制与标签
|
|
236
|
-
|
|
237
|
-
所有文档都应纳入 Git 版本控制。
|
|
238
|
-
|
|
239
|
-
当一个 RT 完成时,推荐在:
|
|
240
|
-
|
|
241
|
-
- 代码分支合并后打上 tag(例如 `done-RT-XXX`);
|
|
242
|
-
- 在 RT 的 `changelog.md` 中记录最终状态;
|
|
243
|
-
- 如果本次 RT 涉及 AODW 制度本身的更新(例如修改了 `aodw-constitution.md`),应特别标注。
|
|
244
|
-
|
|
245
|
-
---
|
|
246
|
-
|
|
247
|
-
## 7. 过程文档管理规则
|
|
248
|
-
|
|
249
|
-
过程文档是指在 RT 执行过程中产生的、用于记录分析、调研、决策等过程的文档。
|
|
250
|
-
|
|
251
|
-
**存储位置**:必须存放在 `RT/RT-XXX/docs/` 目录下,禁止与核心文档混放在根目录。
|
|
252
|
-
|
|
253
|
-
**命名规范**:使用小写字母和连字符(如 `dependency-installation-strategy.md`),避免使用序号前缀。
|
|
254
|
-
|
|
255
|
-
**何时创建**:进行策略分析、技术调研、设计决策、问题诊断、修复总结时。
|
|
256
|
-
|
|
257
|
-
**与核心文档的关系**:过程文档是对核心文档的补充和细化,不应替代核心文档。
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
## 8. 当信息缺失或不确定时
|
|
262
|
-
|
|
263
|
-
如果 AI 判断文档中存在以下情况:
|
|
264
|
-
|
|
265
|
-
- 信息缺失;
|
|
266
|
-
- 描述明显过时;
|
|
267
|
-
- 与代码行为明显矛盾;
|
|
268
|
-
|
|
269
|
-
则 AI 应:
|
|
270
|
-
|
|
271
|
-
1. 在当前 RT 中开辟一小节(可放在 `changelog.md` 或 `docs/` 目录下的单独文档中)记录发现的问题;
|
|
272
|
-
2. 尝试基于当前代码自动修正文档;
|
|
273
|
-
3. 在不确定时向用户提出明确问题,获取确认后再更新文档。
|
|
274
|
-
|
|
275
|
-
AI 不应在发现明显不一致时保持沉默。
|
|
276
|
-
|
|
277
|
-
---
|
|
278
|
-
---
|
|
279
|
-
|
|
280
|
-
## 9. RT 元数据与索引维护规则
|
|
281
|
-
|
|
282
|
-
**元数据优先级**:`RT/RT-XXX/meta.yaml` 是权威来源,`RT/index.yaml` 是全局汇总。如不一致,以 meta.yaml 为准。
|
|
283
|
-
|
|
284
|
-
**何时更新 meta.yaml**:RT 创建、类型/Profile/状态/模块/工具/负责人变更、RT 结束时。
|
|
285
|
-
|
|
286
|
-
**何时更新 index.yaml**:新建 RT、meta.yaml 发生变更时同步更新。详细操作规范见 `.aodw/02-workflow/rt-manager.md` 第 9 节。
|
|
287
|
-
|
|
288
|
-
**一致性检查**:RT 进入 `done` 状态前,检查 meta.yaml 与 index.yaml 是否一致。
|
|
289
|
-
|
|
290
|
-
---
|
|
291
|
-
|
|
292
|
-
## 9.5 时间字段获取规则
|
|
293
|
-
|
|
294
|
-
⚠️ **重要**:所有时间字段必须使用系统真实时间,严禁 AI 自行推断或使用假时间。
|
|
295
|
-
|
|
296
|
-
**详细规则**:请参考 `.aodw/02-workflow/rt-manager.md` 第 10 节"时间字段获取规则(强制要求)"。
|
|
297
|
-
|
|
298
|
-
**关键要求**:
|
|
299
|
-
- 必须通过系统命令或 API 获取真实时间
|
|
300
|
-
- 禁止使用 AI 训练数据、对话上下文或自行推断的时间
|
|
301
|
-
- 时间格式:ISO8601(如 `2025-11-28T11:54:45Z`)
|
|
302
|
-
- 适用范围:`meta.yaml`、`RT/index.yaml`、`AODW_Governance/version.md` 等所有时间字段
|
|
@@ -1,284 +0,0 @@
|
|
|
1
|
-
# AI 项目概览初始化规则
|
|
2
|
-
|
|
3
|
-
> **注意**:本文件定义 AI 如何引导用户完善项目概览信息。
|
|
4
|
-
|
|
5
|
-
**适用场景**:
|
|
6
|
-
- 用户说"初始化项目概览"、"完善项目信息"、"更新架构描述"等
|
|
7
|
-
- 检测到 `ai-overview.md` 存在但内容不完整(标记为"需要完善")
|
|
8
|
-
- 用户要求 AI 帮助完善架构描述、模块职责等复杂信息
|
|
9
|
-
|
|
10
|
-
**必须与以下规范配合使用**:
|
|
11
|
-
- `.aodw/06-project/ai-overview.md`(项目概览文件)
|
|
12
|
-
- `.aodw/06-project/modules-index.yaml`(模块索引)
|
|
13
|
-
- `.aodw/01-core/ai-knowledge-rules.md`(知识维护规则)
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## 1. 触发条件
|
|
18
|
-
|
|
19
|
-
当用户表达以下意图时,AI 必须执行项目概览完善流程:
|
|
20
|
-
|
|
21
|
-
**明确命令**:
|
|
22
|
-
- "初始化项目概览"
|
|
23
|
-
- "完善项目信息"
|
|
24
|
-
- "更新架构描述"
|
|
25
|
-
- "完善模块职责"
|
|
26
|
-
- "更新项目概览"
|
|
27
|
-
|
|
28
|
-
**隐含意图**:
|
|
29
|
-
- "AI 帮我完善一下项目信息"
|
|
30
|
-
- "架构描述不完整,帮我补充"
|
|
31
|
-
- "模块信息需要更新"
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
## 2. 执行流程
|
|
36
|
-
|
|
37
|
-
### Step 1: 读取现有信息
|
|
38
|
-
|
|
39
|
-
AI 必须:
|
|
40
|
-
1. 读取 `.aodw/06-project/ai-overview.md`
|
|
41
|
-
2. 读取 `.aodw/06-project/modules-index.yaml`
|
|
42
|
-
3. 识别哪些内容是自动检测的(标记为 `<!-- AUTO-DETECTED -->`)
|
|
43
|
-
4. 识别哪些内容是用户手动添加的(标记为 `<!-- USER-ADDED -->`)
|
|
44
|
-
5. 识别哪些内容需要完善(标记为"待补充"或缺失)
|
|
45
|
-
|
|
46
|
-
### Step 2: 确定初始化模式
|
|
47
|
-
|
|
48
|
-
AI 必须先判断当前项目状态:
|
|
49
|
-
1. 检查根目录是否为空(排除 `.aodw` 和隐藏文件)
|
|
50
|
-
2. 检查关键文件(`package.json`, `pom.xml`, `requirements.txt`, `src` 目录等)
|
|
51
|
-
|
|
52
|
-
**分支 A:接手老项目(检测模式)**
|
|
53
|
-
- **判定条件**:检测到现有代码或配置文件。
|
|
54
|
-
- **AI 行为**:
|
|
55
|
-
1. 自动扫描代码结构。
|
|
56
|
-
2. 识别技术栈和依赖关系。
|
|
57
|
-
3. 填充 `ai-overview.md` 的草稿。
|
|
58
|
-
4. 引导用户确认检测结果。
|
|
59
|
-
|
|
60
|
-
**分支 B:全新空项目(设计模式)**
|
|
61
|
-
- **判定条件**:目录为空或仅包含 AODW 初始文件。
|
|
62
|
-
- **AI 行为**:
|
|
63
|
-
1. 启动"架构师访谈模式"。
|
|
64
|
-
2. 询问用户意图:"由于是新项目,请问您打算构建什么系统?采用什么技术栈?"
|
|
65
|
-
3. 根据用户回答,生成建议的 `ai-overview.md`(作为设计蓝图)。
|
|
66
|
-
4. 协助规划基础目录结构(Scaffolding)。
|
|
67
|
-
|
|
68
|
-
### Step 3: 引导用户完善
|
|
69
|
-
|
|
70
|
-
AI 必须按照以下顺序引导用户完善信息:
|
|
71
|
-
|
|
72
|
-
#### 3.1 技术栈确认
|
|
73
|
-
|
|
74
|
-
**如果技术栈部分不完整**:
|
|
75
|
-
- AI 读取 CLI 检测到的技术栈
|
|
76
|
-
- 询问用户确认或补充:
|
|
77
|
-
```
|
|
78
|
-
检测到的技术栈:
|
|
79
|
-
- 前端:React 18.3.0、TypeScript 5.0.0
|
|
80
|
-
- 后端:FastAPI 0.104.0、Python 3.11
|
|
81
|
-
|
|
82
|
-
请确认是否正确,或补充缺失的信息:
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
#### 3.2 架构概览
|
|
86
|
-
|
|
87
|
-
**如果架构概览部分为空或标记为"待补充"**:
|
|
88
|
-
- AI 基于技术栈和目录结构生成架构图建议
|
|
89
|
-
- 引导用户确认或修改:
|
|
90
|
-
```
|
|
91
|
-
基于项目结构,建议的架构概览:
|
|
92
|
-
|
|
93
|
-
```text
|
|
94
|
-
[ Web Client (React) ]
|
|
95
|
-
|
|
|
96
|
-
[ API Gateway (FastAPI) ]
|
|
97
|
-
|
|
|
98
|
-
[ Services / Domain ]
|
|
99
|
-
|
|
|
100
|
-
[ PostgreSQL / Redis ]
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
请确认是否符合您的架构,或提供修改建议。
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
#### 3.3 模块职责
|
|
107
|
-
|
|
108
|
-
**如果模块职责部分不完整**:
|
|
109
|
-
- AI 读取 `modules-index.yaml` 中的模块列表
|
|
110
|
-
- 对于每个模块,AI 分析代码结构,生成职责建议
|
|
111
|
-
- 引导用户确认或补充:
|
|
112
|
-
```
|
|
113
|
-
检测到模块:user、order、payment
|
|
114
|
-
|
|
115
|
-
基于代码分析,建议的模块职责:
|
|
116
|
-
|
|
117
|
-
### user 模块
|
|
118
|
-
- **职责**:用户认证、授权、用户资料管理
|
|
119
|
-
- **关键路径**:backend/app/users/**
|
|
120
|
-
- **依赖关系**:被 order、payment 模块调用
|
|
121
|
-
|
|
122
|
-
请确认或补充每个模块的职责和约束。
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
#### 3.4 系统级 Invariants
|
|
126
|
-
|
|
127
|
-
**如果 Invariants 部分为空或标记为"待补充"**:
|
|
128
|
-
- AI 基于代码分析生成初始约束建议
|
|
129
|
-
- 引导用户确认或添加:
|
|
130
|
-
```
|
|
131
|
-
基于代码结构分析,建议的系统级约束:
|
|
132
|
-
|
|
133
|
-
- 不得绕过 service 层直接访问 DB
|
|
134
|
-
- 不得无故更改对外 API 返回格式
|
|
135
|
-
- 不得在热路径引入明显的性能退化
|
|
136
|
-
|
|
137
|
-
请确认或补充其他约束。
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
#### 3.5 历史关键变更
|
|
141
|
-
|
|
142
|
-
**如果历史变更部分为空**:
|
|
143
|
-
- AI 询问用户是否有重要的架构演进里程碑
|
|
144
|
-
- 引导用户记录:
|
|
145
|
-
```
|
|
146
|
-
是否有重要的架构演进里程碑需要记录?
|
|
147
|
-
例如:
|
|
148
|
-
- 2025-01:引入新订单系统
|
|
149
|
-
- 2025-03:从单体拆分为微服务
|
|
150
|
-
|
|
151
|
-
如有,请提供时间和描述。
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### Step 4: 更新文件
|
|
155
|
-
|
|
156
|
-
AI 必须:
|
|
157
|
-
1. 将用户确认的信息更新到 `ai-overview.md`
|
|
158
|
-
2. 标记用户添加的内容为 `<!-- USER-ADDED -->`
|
|
159
|
-
3. 更新 `modules-index.yaml`(如有模块信息变更)
|
|
160
|
-
4. 确保格式符合模板要求
|
|
161
|
-
|
|
162
|
-
---
|
|
163
|
-
|
|
164
|
-
## 3. 交互格式
|
|
165
|
-
|
|
166
|
-
AI 必须遵循 `ai-interaction-rules.md` 中的交互规范:
|
|
167
|
-
|
|
168
|
-
**问题格式**:
|
|
169
|
-
```
|
|
170
|
-
Q1. [问题描述]
|
|
171
|
-
|
|
172
|
-
A. [选项1](推荐)
|
|
173
|
-
B. [选项2]
|
|
174
|
-
C. [选项3]
|
|
175
|
-
|
|
176
|
-
Recommended: A(理由:...)
|
|
177
|
-
|
|
178
|
-
请回复:A/B/C
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
**确认格式**:
|
|
182
|
-
```
|
|
183
|
-
检测到以下信息:
|
|
184
|
-
- [信息1]
|
|
185
|
-
- [信息2]
|
|
186
|
-
|
|
187
|
-
请确认是否正确,或提供修改建议。
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
---
|
|
191
|
-
|
|
192
|
-
## 4. 内容标记规范
|
|
193
|
-
|
|
194
|
-
### 自动检测的内容
|
|
195
|
-
```markdown
|
|
196
|
-
<!-- AUTO-DETECTED: 以下内容由 aodw init-overview 自动检测 -->
|
|
197
|
-
- 前端:React 18.3.0
|
|
198
|
-
- 后端:FastAPI 0.104.0
|
|
199
|
-
<!-- END AUTO-DETECTED -->
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### 用户手动添加的内容
|
|
203
|
-
```markdown
|
|
204
|
-
<!-- USER-ADDED: 以下内容由用户手动添加 -->
|
|
205
|
-
- 数据库:PostgreSQL 15(使用连接池,最大连接数 100)
|
|
206
|
-
<!-- END USER-ADDED -->
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
### AI 引导完善的内容
|
|
210
|
-
```markdown
|
|
211
|
-
<!-- AI-ENHANCED: 以下内容由 AI 引导用户完善 -->
|
|
212
|
-
- 架构概览:[架构图]
|
|
213
|
-
<!-- END AI-ENHANCED -->
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
---
|
|
217
|
-
|
|
218
|
-
## 5. 更新策略
|
|
219
|
-
|
|
220
|
-
### 保留原则
|
|
221
|
-
1. **保留用户内容**:所有标记为 `<!-- USER-ADDED -->` 的内容必须保留
|
|
222
|
-
2. **更新检测内容**:标记为 `<!-- AUTO-DETECTED -->` 的内容可以更新
|
|
223
|
-
3. **完善待补充内容**:标记为"待补充"的内容由 AI 引导用户完善
|
|
224
|
-
|
|
225
|
-
### 冲突处理
|
|
226
|
-
当用户手动修改的内容与检测结果冲突时:
|
|
227
|
-
1. AI 必须显示差异
|
|
228
|
-
2. AI 必须询问用户如何处理
|
|
229
|
-
3. AI 必须等待用户确认后再更新
|
|
230
|
-
|
|
231
|
-
---
|
|
232
|
-
|
|
233
|
-
## 6. 完成标准
|
|
234
|
-
|
|
235
|
-
项目概览完善完成的标准:
|
|
236
|
-
- [ ] 技术栈信息完整且准确
|
|
237
|
-
- [ ] 架构概览已描述或提供架构图
|
|
238
|
-
- [ ] 目录结构已列出关键目录
|
|
239
|
-
- [ ] 核心业务模块职责已描述
|
|
240
|
-
- [ ] 系统级 Invariants 已列出
|
|
241
|
-
- [ ] 模块 README 映射表已建立
|
|
242
|
-
- [ ] 历史关键变更已记录(如有)
|
|
243
|
-
|
|
244
|
-
---
|
|
245
|
-
|
|
246
|
-
## 7. 注意事项
|
|
247
|
-
|
|
248
|
-
1. **不要覆盖用户内容**:所有用户手动添加的内容必须保留
|
|
249
|
-
2. **逐步完善**:不要一次性要求用户完善所有信息,可以分步骤进行
|
|
250
|
-
3. **提供建议**:AI 应该基于代码分析提供建议,而不是只询问用户
|
|
251
|
-
4. **格式规范**:确保生成的内容符合 `ai-overview.md` 的模板格式
|
|
252
|
-
5. **及时更新**:当项目结构发生变化时,提醒用户运行 `aodw init-overview` 更新
|
|
253
|
-
|
|
254
|
-
---
|
|
255
|
-
|
|
256
|
-
## 8. 与 CLI 命令的关系
|
|
257
|
-
|
|
258
|
-
- **CLI 命令**(`aodw init-overview`):负责自动检测和生成基础信息
|
|
259
|
-
- **AI 规则**(本文件):负责引导用户完善复杂信息(架构描述、模块职责等)
|
|
260
|
-
|
|
261
|
-
两者配合使用:
|
|
262
|
-
1. 用户运行 `aodw init-overview` 生成基础信息
|
|
263
|
-
2. 用户运行"初始化项目概览"命令,AI 引导完善详细信息
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
### Step 5: 完成后的下一步
|
|
270
|
-
|
|
271
|
-
完成项目概览后,AI 必须强烈建议用户进行工具初始化:
|
|
272
|
-
|
|
273
|
-
```markdown
|
|
274
|
-
✅ 项目概览初始化完成!
|
|
275
|
-
|
|
276
|
-
⚠️ 下一步建议(重要):
|
|
277
|
-
**执行工具初始化**
|
|
278
|
-
由于我们已经确定了项目技术栈,现在请运行:
|
|
279
|
-
`aodw init-tools` 或告诉 AI "初始化工具"
|
|
280
|
-
|
|
281
|
-
这将根据 ai-overview.md 中的技术栈,为您自动配置:
|
|
282
|
-
- 前端:ESLint / Prettier (基于 React/Vue)
|
|
283
|
-
- 后端:Ruff / Black / Maven (基于 Python/Java)
|
|
284
|
-
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# AODW Constitution Summary
|
|
2
|
-
|
|
3
|
-
## 核心理念
|
|
4
|
-
- KISS:保持简单,避免过度设计
|
|
5
|
-
- 第一性原理分析
|
|
6
|
-
- 事实为本,允许纠错
|
|
7
|
-
- 渐进式开发:构思 → 审核 → 执行
|
|
8
|
-
- 中文交流为默认标准
|
|
9
|
-
|
|
10
|
-
## 关键规则
|
|
11
|
-
- 输出与交互必须选项化并给出推荐理由
|
|
12
|
-
- 文档与代码必须同步,不一致视为 Bug
|
|
13
|
-
- 复杂任务必须维护 `task.md`(Spec-Full 必需)
|
|
14
|
-
|
|
15
|
-
## 架构层级
|
|
16
|
-
- 交互层 / 编排层 / 执行层 / 知识层
|
|
17
|
-
|
|
18
|
-
## 统一要求
|
|
19
|
-
- RT-ID、目录、分支命名必须规范
|
|
20
|
-
- 关键文档需持续维护并保持一致
|