aodw-skill 0.7.3

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.
Files changed (188) hide show
  1. package/.aodw/01-core/ai-interaction-rules.md +218 -0
  2. package/.aodw/01-core/ai-knowledge-rules.md +302 -0
  3. package/.aodw/01-core/ai-project-overview-rules.md +284 -0
  4. package/.aodw/01-core/aodw-constitution-summary.md +20 -0
  5. package/.aodw/01-core/aodw-constitution.md +419 -0
  6. package/.aodw/01-core/csf-thinking-framework.md +373 -0
  7. package/.aodw/01-core/git-discipline.md +226 -0
  8. package/.aodw/01-core/module-doc-rules.md +90 -0
  9. package/.aodw/02-workflow/aodw-development-stages.md +235 -0
  10. package/.aodw/02-workflow/rt-id-generation-rules.md +267 -0
  11. package/.aodw/02-workflow/rt-manager-summary.md +15 -0
  12. package/.aodw/02-workflow/rt-manager.md +399 -0
  13. package/.aodw/02-workflow/spec-full-profile-summary.md +13 -0
  14. package/.aodw/02-workflow/spec-full-profile.md +391 -0
  15. package/.aodw/02-workflow/spec-lite-profile.md +313 -0
  16. package/.aodw/02-workflow/ui-workflow-rules.md +334 -0
  17. package/.aodw/03-standards/ai-coding-rules-common.md +89 -0
  18. package/.aodw/03-standards/ai-coding-rules.md +370 -0
  19. package/.aodw/03-standards/stacks/java-springboot/ai-coding-rules-backend.md +100 -0
  20. package/.aodw/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md +612 -0
  21. package/.aodw/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md +291 -0
  22. package/.aodw/03-standards/stacks/vue2/ai-coding-rules-frontend.md +97 -0
  23. package/.aodw/03-standards/ui-kit/ui-kit.md +163 -0
  24. package/.aodw/04-auditors/aodw-development-auditor-rules.md +470 -0
  25. package/.aodw/04-auditors/aodw-full-auditor-rules.md +365 -0
  26. package/.aodw/04-auditors/aodw-requirement-auditor-rules.md +408 -0
  27. package/.aodw/05-tooling/ai-tools-init-rules.md +465 -0
  28. package/.aodw/06-project/ai-overview.md +116 -0
  29. package/.aodw/06-project/modules-index.yaml +11 -0
  30. package/.aodw/07-optimization/token-usage-analysis.md +253 -0
  31. package/.aodw/README.md +26 -0
  32. package/.aodw/RELEASE-CHECKLIST.md +144 -0
  33. package/.aodw/config.yaml +2 -0
  34. package/.aodw/manifest.yaml +98 -0
  35. package/.aodw/templates/SOURCE-TO-DISTRIBUTION-GUIDE.md +276 -0
  36. package/.aodw/templates/TEMPLATE-APPLICATION-GUIDE.md +246 -0
  37. package/.aodw/templates/aodw-kernel-loader-template.md +70 -0
  38. package/.aodw/templates/audit-report-template.md +232 -0
  39. package/.aodw/templates/changelog-template.md +16 -0
  40. package/.aodw/templates/checklists/coding-standards-template.md +110 -0
  41. package/.aodw/templates/csf-review-template.md +201 -0
  42. package/.aodw/templates/impact-template.md +17 -0
  43. package/.aodw/templates/invariants-template.md +12 -0
  44. package/.aodw/templates/module-readme-template.md +39 -0
  45. package/.aodw/templates/plan-lite-template.md +11 -0
  46. package/.aodw/templates/rt-decision-template.md +13 -0
  47. package/.aodw/templates/rt-intake-template.md +33 -0
  48. package/.aodw/templates/rt-meta-template.yaml +43 -0
  49. package/.aodw/templates/spec-lite-template.md +17 -0
  50. package/.aodw/templates/tests-template.md +13 -0
  51. package/.aodw/templates/tools-config/README.md +80 -0
  52. package/.aodw/templates/tools-config/backend/black.config.template.toml +6 -0
  53. package/.aodw/templates/tools-config/backend/pre-commit.config.template.yaml +16 -0
  54. package/.aodw/templates/tools-config/backend/ruff.config.template.toml +23 -0
  55. package/.aodw/templates/tools-config/frontend/eslint.config.template.json +113 -0
  56. package/.aodw/templates/tools-config/frontend/prettier.config.template.json +10 -0
  57. package/.aodw/templates/tools-config/frontend/tsconfig.paths.template.json +11 -0
  58. package/.aodw/workflow-guide.md +51 -0
  59. package/AODW_Adapters/README.md +143 -0
  60. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-check.md +7 -0
  61. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-done.md +7 -0
  62. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-full.md +7 -0
  63. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-governance.md +7 -0
  64. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-impact.md +7 -0
  65. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-init.md +7 -0
  66. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-invariants.md +7 -0
  67. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-lite.md +7 -0
  68. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-module.md +7 -0
  69. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-new.md +7 -0
  70. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-open.md +7 -0
  71. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-pause.md +7 -0
  72. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-resume.md +7 -0
  73. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-tests.md +7 -0
  74. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-upgrade.md +7 -0
  75. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw.md +35 -0
  76. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-check.md +16 -0
  77. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-done.md +16 -0
  78. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-full.md +14 -0
  79. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-governance.md +13 -0
  80. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-impact.md +13 -0
  81. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-init.md +13 -0
  82. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-invariants.md +13 -0
  83. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-lite.md +14 -0
  84. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-module.md +13 -0
  85. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-new.md +30 -0
  86. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-open.md +10 -0
  87. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-pause.md +12 -0
  88. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-resume.md +12 -0
  89. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-tests.md +13 -0
  90. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-upgrade.md +12 -0
  91. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw.md +18 -0
  92. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/claude/CLAUDE.md +17 -0
  93. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-check.md +30 -0
  94. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-done.md +52 -0
  95. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-full.md +31 -0
  96. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-governance.md +34 -0
  97. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-impact.md +25 -0
  98. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-init.md +75 -0
  99. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-invariants.md +29 -0
  100. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-lite.md +23 -0
  101. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-module.md +24 -0
  102. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-new.md +70 -0
  103. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-open.md +19 -0
  104. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-pause.md +19 -0
  105. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-resume.md +20 -0
  106. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-tests.md +26 -0
  107. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-upgrade.md +27 -0
  108. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw.md +69 -0
  109. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/deploypromote.md +20 -0
  110. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/featuretotester.md +32 -0
  111. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/feature_to_master_push_test_local.sh +390 -0
  112. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/promote_only.sh +210 -0
  113. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/rollback_prod.sh +99 -0
  114. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/rules/aodw.mdc +26 -0
  115. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-check.md +29 -0
  116. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-done.md +52 -0
  117. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-full.md +30 -0
  118. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-governance.md +33 -0
  119. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-impact.md +24 -0
  120. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-init.md +75 -0
  121. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-invariants.md +28 -0
  122. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-lite.md +22 -0
  123. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-module.md +23 -0
  124. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-new.md +92 -0
  125. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-open.md +18 -0
  126. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-pause.md +18 -0
  127. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-resume.md +19 -0
  128. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-tests.md +25 -0
  129. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-upgrade.md +26 -0
  130. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw.md +68 -0
  131. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/GEMINI.md +17 -0
  132. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-analyze.md +15 -0
  133. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-complete.md +15 -0
  134. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-control.md +14 -0
  135. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-decide.md +16 -0
  136. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-governance.md +7 -0
  137. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-implement.md +16 -0
  138. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-init.md +7 -0
  139. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-intake.md +15 -0
  140. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-open.md +7 -0
  141. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-simplified.md +107 -0
  142. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-verify.md +14 -0
  143. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-analyze.md +24 -0
  144. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-complete.md +23 -0
  145. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-control.md +21 -0
  146. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-decide.md +26 -0
  147. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-governance.md +13 -0
  148. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-implement.md +21 -0
  149. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-init.md +13 -0
  150. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-intake.md +28 -0
  151. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-open.md +10 -0
  152. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-verify.md +20 -0
  153. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw.md +18 -0
  154. package/AODW_Adapters/antigravity/.agent/rules/aodw.md +74 -0
  155. package/AODW_Adapters/claude/CLAUDE.md +70 -0
  156. package/AODW_Adapters/cursor/.cursor/commands/README.md +37 -0
  157. package/AODW_Adapters/cursor/.cursor/rules/aodw.mdc +77 -0
  158. package/AODW_Adapters/gemini/.agent/rules/aodw-analyze.md +15 -0
  159. package/AODW_Adapters/gemini/.agent/rules/aodw-complete.md +15 -0
  160. package/AODW_Adapters/gemini/.agent/rules/aodw-control.md +14 -0
  161. package/AODW_Adapters/gemini/.agent/rules/aodw-decide.md +16 -0
  162. package/AODW_Adapters/gemini/.agent/rules/aodw-governance.md +33 -0
  163. package/AODW_Adapters/gemini/.agent/rules/aodw-implement.md +16 -0
  164. package/AODW_Adapters/gemini/.agent/rules/aodw-init.md +75 -0
  165. package/AODW_Adapters/gemini/.agent/rules/aodw-intake.md +15 -0
  166. package/AODW_Adapters/gemini/.agent/rules/aodw-open.md +18 -0
  167. package/AODW_Adapters/gemini/.agent/rules/aodw-verify.md +14 -0
  168. package/AODW_Adapters/gemini/.agent/rules/aodw.md +70 -0
  169. package/AODW_Adapters/gemini/GEMINI.md +17 -0
  170. package/AODW_Adapters/general/.github/copilot-instructions.md +34 -0
  171. package/AODW_Adapters/general/AGENTS.md +70 -0
  172. package/README.md +118 -0
  173. package/bin/aodw.js +627 -0
  174. package/bin/commands/init-overview.js +801 -0
  175. package/bin/commands/init-tools.js +811 -0
  176. package/bin/commands/new.js +235 -0
  177. package/bin/commands/serve.js +79 -0
  178. package/bin/processors/index.js +109 -0
  179. package/bin/update-adapters-from-template.js +89 -0
  180. package/bin/utils/config.js +56 -0
  181. package/docs/README.md +26 -0
  182. package/docs/adapter-evaluation.md +55 -0
  183. package/docs/backend-guidelines.md +335 -0
  184. package/docs/frontend-guidelines.md +266 -0
  185. package/docs/installation-variants.md +88 -0
  186. package/docs/migration-guide-0.2.0.md +250 -0
  187. package/docs/platform-matrix.md +83 -0
  188. package/package.json +40 -0
@@ -0,0 +1,218 @@
1
+ 0. UI 任务判断(前置检查)
2
+
3
+ 在执行任何任务之前,AI 必须首先进行 **任务类型判断**,识别是否为 UI 相关任务。
4
+
5
+ ### 0.1 UI 相关任务判定条件
6
+
7
+ 以下任意条件满足,即视为 **UI 相关任务**:
8
+ - ✅ 涉及页面、界面、布局、组件、表单、Dashboard
9
+ - ✅ 涉及用户操作流程、交互体验、可视化
10
+ - ✅ 涉及前端 UI、样式、视觉呈现
11
+ - ✅ 用户明确提到"界面 / UI / 好看 / 丑 / 设计"
12
+ - ✅ 涉及 UI 改造、UI 新建、UI 优化
13
+
14
+ ### 0.2 判断时机
15
+
16
+ - **RT 创建阶段**:在 `intake.md` 生成时进行判断
17
+ - **任务执行阶段**:在执行任何代码修改前进行判断
18
+ - **需求变更阶段**:当用户提出新需求时重新判断
19
+
20
+ ### 0.3 判断结果处理
21
+
22
+ - **非 UI 相关任务**:按正常 AODW 流程执行
23
+ - **UI 相关任务**:**必须进入 UI 专用流程**
24
+
25
+ > **详细规则**:请参考 `.aodw/02-workflow/ui-workflow-rules.md`
26
+
27
+ ---
28
+
29
+ 1. 问题类型(两大类)
30
+ AI 所提出的所有问题必须明确属于:
31
+ 1. 决策型(Decision Question)
32
+ • 必须提供选项
33
+ • 必须明确推荐项
34
+ • 必须给出推荐理由
35
+ • 必须支持 "custom: …"(≤ 5 个词)
36
+ 2. 信息型(Information Question)
37
+ • 用于收集信息
38
+ • 必须提供示例答案
39
+ • 必须限制用户输入不超过 10 个词
40
+ • 必须保证问题可被快速回答
41
+
42
+
43
+
44
+ 2. 问题的格式规范
45
+ 所有问题必须遵守格式(AI 必须严格采用):
46
+ Q1. <问题内容>
47
+
48
+ A. <选项1>
49
+ B. <选项2>
50
+ C. <选项3>
51
+ D. <选项4>
52
+
53
+ Recommended: B(理由:……)
54
+
55
+ 请回复:A/B/C/D 或 custom:<你的答案>
56
+
57
+ 信息型问题格式:
58
+ Q2. <要确认的信息>
59
+
60
+ 示例答案:
61
+ - "订单服务"
62
+ - "支付模块"
63
+ - "只影响前端"
64
+
65
+ 请给我一个 ≤10个词的回答。
66
+
67
+ 3. 每轮最多提出的问题数量
68
+ • 🚫 单轮禁止提出超过 5 个问题
69
+ • 建议每轮 3 个 以内
70
+ • 超过 3 个必须提示用户原因(例如:需求范围大,需要更多澄清)
71
+
72
+
73
+
74
+ 4. AI 问题的节奏(Flow Control)
75
+ AI 必须遵守:
76
+ • 不得一次性问一大堆问题
77
+ • 必须逐步推进(Ask → Wait → Respond → Continue)
78
+ • 每轮问题结束后必须总结本轮收集到的信息
79
+ • 不能在用户未回答的情况下继续提出下一组问题
80
+
81
+
82
+
83
+ 5. 用户中断与暂停机制
84
+ AI 必须支持以下命令:
85
+ • "先暂停 AODW"
86
+ • "等一下,不继续流程"
87
+ • "跳过这一步"
88
+
89
+ AI 必须立即:
90
+ • 停止流程推进
91
+ • 切换到「普通代码助手模式」
92
+ • 并要求用户说"继续 AODW"才能回到流程
93
+
94
+
95
+
96
+ 5.5. UI 流程主动触发机制
97
+
98
+ 用户可以在任何时候主动触发 UI 相关流程,AI 必须识别并执行以下命令:
99
+
100
+ ### 5.5.1 UI 流程触发命令识别
101
+
102
+ AI 必须识别以下用户指令(支持多种表达方式):
103
+
104
+ | 触发类型 | 触发词示例 | 执行动作 |
105
+ |---------|-----------|---------|
106
+ | **UI 设计** | "请 AODW 规范,帮我就当前这个 RT 任务的界面进行设计"<br>"按 AODW 规范设计界面"<br>"设计 UI"<br>"生成界面原型" | 执行 UI 设计流程(规则文件读取 → UI 结构与设计说明 → 静态 HTML 原型生成 → 用户确认) |
107
+ | **UI 审计/审查** | "请 AODW 规范,帮我就当前这个 RT 任务的界面进行审计"<br>"审计界面"<br>"审查 UI"<br>"检查界面" | 执行 UI Critic 审查流程(切换到 UI Critic 角色,按 `.aodw/03-standards/ui-kit/ui-kit.md` 第 4 节标准审查) |
108
+ | **UI 挑毛病** | "请 AODW 规范,帮我就当前这个 RT 任务的界面挑毛病"<br>"挑 UI 毛病"<br>"找界面问题"<br>"UI 有什么问题" | 执行 UI Critic 审查流程(严格审查,指出所有问题) |
109
+
110
+ ### 5.5.2 触发条件检查
111
+
112
+ 当用户触发 UI 流程时,AI 必须:
113
+
114
+ 1. **检查当前 RT 上下文**
115
+ - 确认是否存在当前 RT(检查 `RT/RT-XXX/` 目录)
116
+ - 如果不存在,提示用户:"未找到当前 RT,请先创建或打开一个 RT"
117
+ - 如果存在,读取 `intake.md` 或 `spec.md` / `spec-lite.md` 了解任务内容
118
+
119
+ 2. **检查是否为 UI 相关任务**
120
+ - 如果 `intake.md` 中标注了 `ui_related: true`,直接进入 UI 流程
121
+ - 如果未标注,但任务涉及 UI(根据第 0 节判断),提示用户:"检测到当前 RT 可能涉及 UI,是否执行 UI 流程?"
122
+ - 如果完全不涉及 UI,提示用户:"当前 RT 不涉及 UI,是否仍要执行 UI 审查?"
123
+
124
+ 3. **执行对应的 UI 流程**
125
+ - **UI 设计**:按照 `.aodw/02-workflow/ui-workflow-rules.md` 第 2 节执行
126
+ - **UI 审计/审查/挑毛病**:按照 `.aodw/02-workflow/ui-workflow-rules.md` 第 3 节执行
127
+
128
+ ### 5.5.3 执行响应模板
129
+
130
+ 当用户触发 UI 流程时,AI 应回复:
131
+
132
+ ```
133
+ ✅ **UI 流程已触发**
134
+ - 当前 RT:[RT-XXX]
135
+ - 触发类型:[设计 / 审计 / 挑毛病]
136
+ - 执行动作:[具体要执行的内容]
137
+ - 参考规范:[.aodw/03-standards/ui-kit/ui-kit.md]
138
+ ```
139
+
140
+ ### 5.5.4 执行优先级
141
+
142
+ - **用户主动触发** > **自动流程触发**
143
+ - 如果用户主动触发 UI 流程,即使当前不在 UI 相关阶段,也应立即执行
144
+ - 执行完成后,询问用户是否继续原流程
145
+
146
+
147
+
148
+ 6. 错误恢复机制
149
+ 如果用户回答不清晰或违背格式,AI 必须:
150
+ • 或再次提出简化问题
151
+ • 并提供新的建议选项
152
+
153
+
154
+
155
+ 7. 透明度与确认机制
156
+
157
+ AI 必须主动维护流程的透明度:
158
+ - **复杂任务追踪**:当任务步骤超过 3 步时,必须创建 `task.md` 并实时更新。
159
+ - **任务追踪检查**:
160
+ - 在执行复杂任务时,AI 应在每个阶段结束后主动检查 task.md 是否需要更新
161
+ - 如果发现 task.md 已过时,必须立即更新并告知用户
162
+ - 在每次提交代码前,AI 必须检查 task.md 是否已更新到最新状态
163
+ - **关键节点确认**:
164
+ - Plan 完成后,必须暂停并请求批准。
165
+ - 代码提交前,必须暂停并请求确认。
166
+
167
+
168
+
169
+ 8. 门禁检查点与用户确认
170
+
171
+ > **重要**:详细的门禁检查点定义见 `aodw-constitution.md` 第 4.5 节。
172
+
173
+ ### 8.1 确认词汇表
174
+
175
+ AI 必须识别以下用户确认指令:
176
+
177
+ | 确认类型 | 触发词 | 范围 |
178
+ | ------------ | -------------------------------- | -------------------------------- |
179
+ | **单步确认** | "继续"、"下一步"、"好"、"ok" | 只批准当前 Gate,进入下一阶段 |
180
+ | **批准执行** | "批准"、"执行"、"approved"、"go" | 批准 Plan,允许开始编码 |
181
+ | **跳过确认** | "跳过"、"skip" | 跳过当前检查点(需二次确认风险) |
182
+ | **暂停流程** | "暂停"、"pause"、"等等"、"停" | 暂停 AODW 流程,切换到普通模式 |
183
+ | **启动审计** | "审计"、"audit" | 启动对应阶段的审计 |
184
+
185
+ ### 8.2 确认边界
186
+
187
+ **关键规则**:
188
+ - ⚠️ 用户说"继续"只意味着"通过当前 Gate",**不是"执行到底"**
189
+ - ⚠️ AI 必须在下一个 Gate 再次等待确认
190
+ - ⚠️ 默认模式下,每个 Gate 只能通过一个确认
191
+
192
+ ### 8.3 确认后响应模板
193
+
194
+ 当用户确认后,AI 应回复:
195
+
196
+ ```
197
+ ✅ **确认收到**
198
+ - 当前操作:[刚才批准的内容]
199
+ - 正在执行:[即将做的事情]
200
+ - 下一检查点:[下一个 Gate 的位置]
201
+ ```
202
+
203
+
204
+
205
+ 9. 分支验证前置
206
+
207
+ AI 在执行任何代码修改操作(`write_to_file`、`replace_file_content`)前,必须:
208
+
209
+ 1. 运行 `git branch --show-current`
210
+ 2. 检查结果:
211
+ - ✅ 如果显示 `feature/RT-XXX-xxx`:继续执行
212
+ - ❌ 如果显示 `main` 或 `master`:**立即停止**
213
+ 3. 如果在 main/master 分支:
214
+ - 提示用户当前在主分支
215
+ - 询问是否创建 feature 分支
216
+ - 创建并切换到分支后才能继续
217
+
218
+ **违规处理**:如果 AI 在 main/master 分支上修改了业务代码,必须立即回滚。
@@ -0,0 +1,302 @@
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` 等所有时间字段