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.
- package/.aodw/01-core/ai-interaction-rules.md +218 -0
- package/.aodw/01-core/ai-knowledge-rules.md +302 -0
- package/.aodw/01-core/ai-project-overview-rules.md +284 -0
- package/.aodw/01-core/aodw-constitution-summary.md +20 -0
- package/.aodw/01-core/aodw-constitution.md +419 -0
- package/.aodw/01-core/csf-thinking-framework.md +373 -0
- package/.aodw/01-core/git-discipline.md +226 -0
- package/.aodw/01-core/module-doc-rules.md +90 -0
- package/.aodw/02-workflow/aodw-development-stages.md +235 -0
- package/.aodw/02-workflow/rt-id-generation-rules.md +267 -0
- package/.aodw/02-workflow/rt-manager-summary.md +15 -0
- package/.aodw/02-workflow/rt-manager.md +399 -0
- package/.aodw/02-workflow/spec-full-profile-summary.md +13 -0
- package/.aodw/02-workflow/spec-full-profile.md +391 -0
- package/.aodw/02-workflow/spec-lite-profile.md +313 -0
- package/.aodw/02-workflow/ui-workflow-rules.md +334 -0
- package/.aodw/03-standards/ai-coding-rules-common.md +89 -0
- package/.aodw/03-standards/ai-coding-rules.md +370 -0
- package/.aodw/03-standards/stacks/java-springboot/ai-coding-rules-backend.md +100 -0
- package/.aodw/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md +612 -0
- package/.aodw/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md +291 -0
- package/.aodw/03-standards/stacks/vue2/ai-coding-rules-frontend.md +97 -0
- package/.aodw/03-standards/ui-kit/ui-kit.md +163 -0
- package/.aodw/04-auditors/aodw-development-auditor-rules.md +470 -0
- package/.aodw/04-auditors/aodw-full-auditor-rules.md +365 -0
- package/.aodw/04-auditors/aodw-requirement-auditor-rules.md +408 -0
- package/.aodw/05-tooling/ai-tools-init-rules.md +465 -0
- package/.aodw/06-project/ai-overview.md +116 -0
- package/.aodw/06-project/modules-index.yaml +11 -0
- package/.aodw/07-optimization/token-usage-analysis.md +253 -0
- package/.aodw/README.md +26 -0
- package/.aodw/RELEASE-CHECKLIST.md +144 -0
- package/.aodw/config.yaml +2 -0
- package/.aodw/manifest.yaml +98 -0
- package/.aodw/templates/SOURCE-TO-DISTRIBUTION-GUIDE.md +276 -0
- package/.aodw/templates/TEMPLATE-APPLICATION-GUIDE.md +246 -0
- package/.aodw/templates/aodw-kernel-loader-template.md +70 -0
- package/.aodw/templates/audit-report-template.md +232 -0
- package/.aodw/templates/changelog-template.md +16 -0
- package/.aodw/templates/checklists/coding-standards-template.md +110 -0
- package/.aodw/templates/csf-review-template.md +201 -0
- package/.aodw/templates/impact-template.md +17 -0
- package/.aodw/templates/invariants-template.md +12 -0
- package/.aodw/templates/module-readme-template.md +39 -0
- package/.aodw/templates/plan-lite-template.md +11 -0
- package/.aodw/templates/rt-decision-template.md +13 -0
- package/.aodw/templates/rt-intake-template.md +33 -0
- package/.aodw/templates/rt-meta-template.yaml +43 -0
- package/.aodw/templates/spec-lite-template.md +17 -0
- package/.aodw/templates/tests-template.md +13 -0
- package/.aodw/templates/tools-config/README.md +80 -0
- package/.aodw/templates/tools-config/backend/black.config.template.toml +6 -0
- package/.aodw/templates/tools-config/backend/pre-commit.config.template.yaml +16 -0
- package/.aodw/templates/tools-config/backend/ruff.config.template.toml +23 -0
- package/.aodw/templates/tools-config/frontend/eslint.config.template.json +113 -0
- package/.aodw/templates/tools-config/frontend/prettier.config.template.json +10 -0
- package/.aodw/templates/tools-config/frontend/tsconfig.paths.template.json +11 -0
- package/.aodw/workflow-guide.md +51 -0
- package/AODW_Adapters/README.md +143 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-check.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-done.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-full.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-governance.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-impact.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-init.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-invariants.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-lite.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-module.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-new.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-open.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-pause.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-resume.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-tests.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-upgrade.md +7 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw.md +35 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-check.md +16 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-done.md +16 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-full.md +14 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-governance.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-impact.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-init.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-invariants.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-lite.md +14 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-module.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-new.md +30 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-open.md +10 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-pause.md +12 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-resume.md +12 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-tests.md +13 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-upgrade.md +12 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw.md +18 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/claude/CLAUDE.md +17 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-check.md +30 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-done.md +52 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-full.md +31 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-governance.md +34 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-impact.md +25 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-init.md +75 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-invariants.md +29 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-lite.md +23 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-module.md +24 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-new.md +70 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-open.md +19 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-pause.md +19 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-resume.md +20 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-tests.md +26 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-upgrade.md +27 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw.md +69 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/deploypromote.md +20 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/featuretotester.md +32 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/feature_to_master_push_test_local.sh +390 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/promote_only.sh +210 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/rollback_prod.sh +99 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/rules/aodw.mdc +26 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-check.md +29 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-done.md +52 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-full.md +30 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-governance.md +33 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-impact.md +24 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-init.md +75 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-invariants.md +28 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-lite.md +22 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-module.md +23 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-new.md +92 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-open.md +18 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-pause.md +18 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-resume.md +19 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-tests.md +25 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-upgrade.md +26 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw.md +68 -0
- package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/GEMINI.md +17 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-analyze.md +15 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-complete.md +15 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-control.md +14 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-decide.md +16 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-governance.md +7 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-implement.md +16 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-init.md +7 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-intake.md +15 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-open.md +7 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-simplified.md +107 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-verify.md +14 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-analyze.md +24 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-complete.md +23 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-control.md +21 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-decide.md +26 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-governance.md +13 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-implement.md +21 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-init.md +13 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-intake.md +28 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-open.md +10 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-verify.md +20 -0
- package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw.md +18 -0
- package/AODW_Adapters/antigravity/.agent/rules/aodw.md +74 -0
- package/AODW_Adapters/claude/CLAUDE.md +70 -0
- package/AODW_Adapters/cursor/.cursor/commands/README.md +37 -0
- package/AODW_Adapters/cursor/.cursor/rules/aodw.mdc +77 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-analyze.md +15 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-complete.md +15 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-control.md +14 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-decide.md +16 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-governance.md +33 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-implement.md +16 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-init.md +75 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-intake.md +15 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-open.md +18 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw-verify.md +14 -0
- package/AODW_Adapters/gemini/.agent/rules/aodw.md +70 -0
- package/AODW_Adapters/gemini/GEMINI.md +17 -0
- package/AODW_Adapters/general/.github/copilot-instructions.md +34 -0
- package/AODW_Adapters/general/AGENTS.md +70 -0
- package/README.md +118 -0
- package/bin/aodw.js +627 -0
- package/bin/commands/init-overview.js +801 -0
- package/bin/commands/init-tools.js +811 -0
- package/bin/commands/new.js +235 -0
- package/bin/commands/serve.js +79 -0
- package/bin/processors/index.js +109 -0
- package/bin/update-adapters-from-template.js +89 -0
- package/bin/utils/config.js +56 -0
- package/docs/README.md +26 -0
- package/docs/adapter-evaluation.md +55 -0
- package/docs/backend-guidelines.md +335 -0
- package/docs/frontend-guidelines.md +266 -0
- package/docs/installation-variants.md +88 -0
- package/docs/migration-guide-0.2.0.md +250 -0
- package/docs/platform-matrix.md +83 -0
- package/package.json +40 -0
|
@@ -0,0 +1,284 @@
|
|
|
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
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
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
|
+
- 关键文档需持续维护并保持一致
|