aodw-skill 0.7.18 → 0.7.19

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 (139) hide show
  1. package/.aodw-next/01-core/csf-thinking-framework.md +1 -1
  2. package/.aodw-next/02-workflow/rt-manager.md +22 -1
  3. package/.aodw-next/02-workflow/ui-workflow-rules.md +0 -3
  4. package/.aodw-next/README.md +0 -1
  5. package/.aodw-next/SKILL.md +5 -5
  6. package/.aodw-next/manifest.yaml +0 -5
  7. package/AODW_Adapters/README.md +24 -31
  8. package/README.md +8 -6
  9. package/bin/aodw.js +7 -78
  10. package/bin/processors/index.js +1 -35
  11. package/bin/update-adapters-from-template.js +1 -15
  12. package/package.json +4 -4
  13. package/.aodw-next/01-core/ai-interaction-rules-summary.md +0 -37
  14. package/.aodw-next/01-core/ai-knowledge-rules-summary.md +0 -25
  15. package/.aodw-next/01-core/git-discipline-summary.md +0 -36
  16. package/.aodw-next/02-workflow/rt-id-generation-rules.md +0 -24
  17. package/.aodw-next/02-workflow/rt-manager-summary.md +0 -15
  18. package/.aodw-next/02-workflow/ui-workflow-rules-summary.md +0 -39
  19. package/.aodw-next/03-standards/stacks/rust-axum/ai-coding-rules-backend.md +0 -134
  20. package/.aodw-next/06-project/README.md +0 -16
  21. package/.aodw-next/07-optimization/token-usage-analysis.md +0 -253
  22. package/.aodw-next/templates/TEMPLATE-APPLICATION-GUIDE.md +0 -110
  23. package/.aodw-next/templates/audit-report-template.md +0 -232
  24. package/.aodw-next/templates/changelog-template.md +0 -16
  25. package/.aodw-next/templates/checklists/coding-standards-template.md +0 -130
  26. package/.aodw-next/templates/csf-review-template.md +0 -201
  27. package/.aodw-next/templates/impact-template.md +0 -17
  28. package/.aodw-next/templates/invariants-template.md +0 -12
  29. package/.aodw-next/templates/plan-lite-template.md +0 -20
  30. package/.aodw-next/templates/rt-decision-template.md +0 -13
  31. package/.aodw-next/templates/rt-intake-template.md +0 -33
  32. package/.aodw-next/templates/spec-lite-template.md +0 -26
  33. package/.aodw-next/templates/tests-template.md +0 -13
  34. package/.aodw-next/templates/tools-config/README.md +0 -112
  35. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-check.md +0 -7
  36. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-done.md +0 -7
  37. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-full.md +0 -7
  38. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-governance.md +0 -7
  39. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-impact.md +0 -7
  40. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-init.md +0 -7
  41. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-invariants.md +0 -7
  42. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-lite.md +0 -7
  43. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-module.md +0 -7
  44. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-new.md +0 -7
  45. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-open.md +0 -7
  46. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-pause.md +0 -7
  47. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-resume.md +0 -7
  48. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-tests.md +0 -7
  49. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw-upgrade.md +0 -7
  50. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/.agent/rules/aodw.md +0 -35
  51. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-check.md +0 -16
  52. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-done.md +0 -16
  53. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-full.md +0 -14
  54. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-governance.md +0 -13
  55. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-impact.md +0 -13
  56. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-init.md +0 -13
  57. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-invariants.md +0 -13
  58. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-lite.md +0 -14
  59. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-module.md +0 -13
  60. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-new.md +0 -30
  61. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-open.md +0 -10
  62. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-pause.md +0 -12
  63. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-resume.md +0 -12
  64. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-tests.md +0 -13
  65. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw-upgrade.md +0 -12
  66. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/antigravity/global_workflows/aodw.md +0 -18
  67. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/claude/CLAUDE.md +0 -17
  68. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-check.md +0 -30
  69. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-done.md +0 -52
  70. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-full.md +0 -31
  71. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-governance.md +0 -34
  72. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-impact.md +0 -25
  73. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-init.md +0 -75
  74. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-invariants.md +0 -29
  75. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-lite.md +0 -23
  76. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-module.md +0 -24
  77. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-new.md +0 -70
  78. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-open.md +0 -19
  79. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-pause.md +0 -19
  80. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-resume.md +0 -20
  81. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-tests.md +0 -26
  82. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw-upgrade.md +0 -27
  83. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/aodw.md +0 -69
  84. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/deploypromote.md +0 -20
  85. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/commands/featuretotester.md +0 -32
  86. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/feature_to_master_push_test_local.sh +0 -390
  87. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/promote_only.sh +0 -210
  88. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/deploy/rollback_prod.sh +0 -99
  89. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/cursor/.cursor/rules/aodw.mdc +0 -26
  90. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-check.md +0 -29
  91. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-done.md +0 -52
  92. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-full.md +0 -30
  93. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-governance.md +0 -33
  94. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-impact.md +0 -24
  95. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-init.md +0 -75
  96. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-invariants.md +0 -28
  97. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-lite.md +0 -22
  98. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-module.md +0 -23
  99. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-new.md +0 -92
  100. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-open.md +0 -18
  101. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-pause.md +0 -18
  102. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-resume.md +0 -19
  103. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-tests.md +0 -25
  104. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw-upgrade.md +0 -26
  105. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/.agent/rules/aodw.md +0 -68
  106. package/AODW_Adapters/_backup/v3.1.0-pre-refactor/gemini/GEMINI.md +0 -17
  107. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-analyze.md +0 -15
  108. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-complete.md +0 -15
  109. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-control.md +0 -14
  110. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-decide.md +0 -16
  111. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-governance.md +0 -7
  112. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-implement.md +0 -16
  113. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-init.md +0 -7
  114. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-intake.md +0 -15
  115. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-open.md +0 -7
  116. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-simplified.md +0 -107
  117. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/.agent/rules/aodw-verify.md +0 -14
  118. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-analyze.md +0 -24
  119. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-complete.md +0 -23
  120. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-control.md +0 -21
  121. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-decide.md +0 -26
  122. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-governance.md +0 -13
  123. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-implement.md +0 -21
  124. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-init.md +0 -13
  125. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-intake.md +0 -28
  126. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-open.md +0 -10
  127. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw-verify.md +0 -20
  128. package/AODW_Adapters/_backup/v4.0.0-simplified/antigravity/global_workflows/aodw.md +0 -18
  129. package/AODW_Adapters/gemini/.agent/rules/aodw-next.md +0 -70
  130. package/AODW_Adapters/gemini/GEMINI.md +0 -18
  131. package/AODW_Adapters/general/.github/copilot-instructions.md +0 -34
  132. package/AODW_Adapters/general/AGENTS.md +0 -70
  133. package/docs/README.md +0 -26
  134. package/docs/adapter-evaluation.md +0 -55
  135. package/docs/backend-guidelines.md +0 -335
  136. package/docs/frontend-guidelines.md +0 -266
  137. package/docs/installation-variants.md +0 -88
  138. package/docs/migration-guide-0.2.0.md +0 -250
  139. package/docs/platform-matrix.md +0 -83
@@ -1,39 +0,0 @@
1
- # UI Workflow Rules (Summary)
2
-
3
- > **注意**:这是 UI 工作流规则的摘要版本,包含核心检查点和流程。
4
- > 完整版本请阅读:`02-workflow/ui-workflow-rules.md`
5
-
6
- ---
7
-
8
- ## 核心检查点
9
-
10
- ### UI 任务必须
11
- - 用户确认后再执行
12
- - 明确任务范围和验收标准
13
- - 记录关键决策和理由
14
-
15
- ### 代码规范
16
- - 遵循 `03-standards/stacks/` 中的 UI 规范
17
- - 使用对应的 UI Kit 组件
18
- - 遵循无障碍设计原则
19
-
20
- ### Git 规范
21
- - 遵循 `01-core/git-discipline.md`
22
- - UI 任务使用 feature 分支
23
-
24
- ---
25
-
26
- ## 快速参考
27
-
28
- | 阶段 | 检查点 | 相关规范 |
29
- |-------|---------|---------|
30
- | 立项 | 明确范围、确认验收标准 | 01-core/ai-interaction-rules |
31
- | 设计 | 组件选择、设计稿评审 | 01-core/ai-interaction-rules |
32
- | 实现 | 代码规范、UI Kit 使用 | 03-standards/stacks/ |
33
- | 验证 | 用户确认、无障碍检查 | 01-core/ai-interaction-rules |
34
-
35
- ---
36
-
37
- ## 需要详细信息时
38
-
39
- 请阅读完整版:`02-workflow/ui-workflow-rules.md`
@@ -1,134 +0,0 @@
1
- # AI Coding Rules - Backend Development (Rust)
2
-
3
- > **注意**:本文件是 `.aodw-next/03-standards/ai-coding-rules.md` 的子规范文件。
4
- > 请先阅读主文件了解通用编码原则。
5
-
6
- **适用场景**:
7
- - 后端开发(Rust + Axum + SQLx)
8
- - 命令行工具开发
9
- - 高性能组件开发
10
-
11
- **依赖规范**:
12
- - [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
13
- - [Effective Rust](https://www.lurklurk.org/effective-rust/)
14
-
15
- ## 1. 核心原则 (Core Principals)
16
-
17
- ### 1.1 稳定性优先 (Stability First)
18
- - **绝对禁止在业务逻辑中使用 `unwrap()` 或 `expect()`**。
19
- - 仅允许在 `tests/`, `examples/`, 或 `bin/` 的初始化阶段(无法恢复的启动错误)使用。
20
- - 业务代码必须使用 `match`, `if let`, 或 `?` 传播 `Result`。
21
- - **避免 Panic**:任何可能 Panic 的操作(如数组索引 `arr[i]`)都应使用安全版本(如 `arr.get(i)`)。
22
-
23
- ### 1.2 错误处理 (Error Handling)
24
- - 使用 `thiserror` 定义库/模块级别的错误枚举。
25
- - 使用 `anyhow` 处理顶层应用(Application)的错误传播。
26
- - **Axum Handler** 必须返回实现了 `IntoResponse` 的 Result 类型(通常自定义 `AppError`)。
27
-
28
- ### 1.3 异步规范 (Async)
29
- - 避免在异步上下文中执行阻塞操作(如标准 `std::fs` 或大量 CPU 计算)。
30
- - 使用 `tokio::fs` 替代 `std::fs`。
31
- - 长时间计算任务使用 `tokio::task::spawn_blocking`。
32
-
33
- ---
34
-
35
- ## 2. 代码风格与命名 (Style & Naming)
36
-
37
- 遵循 `rustfmt` 默认配置。
38
-
39
- - **Types (Structs, Enums, Traits)**: `PascalCase`
40
- - **Functions, Methods, Variables, Modules**: `snake_case`
41
- - **Constants, Statics**: `SCREAMING_SNAKE_CASE`
42
- - **File Names**: `snake_case.rs`
43
-
44
- ---
45
-
46
- ## 3. 目录结构规范 (Directory Structure)
47
-
48
- ```
49
- backend/
50
- src/
51
- bin/ # 独立可执行文件(工具脚本)
52
- routes/ # Axum 路由处理函数 (Handlers)
53
- mod.rs # 路由注册
54
- users.rs # 用户模块路由
55
- models/ # 数据模型 (Structs) & DB 映射
56
- services/ # 业务逻辑层 (可选,复杂逻辑从 routes 剥离)
57
- utils/ # 通用工具函数
58
- main.rs # 应用入口,仅包含启动配置
59
- ```
60
-
61
- - **Routes**: 负责 HTTP 解析、参数校验、调用 Service/Model、返回响应。
62
- - **Services/Models**: 负责核心业务逻辑和数据持久化,不应依赖 HTTP 层细节。
63
-
64
- ---
65
-
66
- ## 4. 最佳实践 (Best Practices)
67
-
68
- ### 4.1 SQLx 使用
69
- - 优先使用 `sqlx::query_as!` 宏进行编译时 SQL 检查。
70
- - 如果必须使用动态 SQL,确保使用参数化查询 (`bind`) 防止注入。
71
- - 数据库模型 Struct 字段应与 DB 列名一致,或使用 `#[sqlx(rename = "...")]`。
72
-
73
- ### 4.2 Axum Handler
74
- - 保持 Handler 瘦身:如果逻辑超过 50 行,考虑提取到 Service 层或独立函数。
75
- - 使用 `State` 抽取共享状态(如 DB Pool)。
76
-
77
- ### 4.3 日志 (Logging)
78
- - 使用 `tracing` 而非 `println!`。
79
- - 关键业务路径必须有 `info!` 日志。
80
- - 错误分支必须有 `error!` 日志,包含上下文信息。
81
-
82
- ---
83
-
84
- ## 5. 工具链配置 (Tooling)
85
-
86
- 所有 Rust 项目必须包含以下配置:
87
-
88
- ### 5.1 工具初始化(必须)
89
-
90
- 在开始开发前,必须运行工具初始化:
91
- - 通过 AI 命令:"初始化工具" 或 "设置开发工具"
92
- - 通过 CLI 命令:`aodw-skill init-tools`
93
-
94
- 工具初始化会自动:
95
- - 检测 rustfmt、clippy、cargo 是否已安装
96
- - 从模板生成 `rustfmt.toml` 和 `clippy.toml` 配置文件
97
- - 配置 pre-commit hooks(如果使用)
98
-
99
- ### 5.2 配置文件
100
-
101
- **rustfmt.toml**(从模板生成):
102
- - 模板位置:`.aodw-next/templates/tools-config/backend/rustfmt.config.template.toml`
103
- - 生成位置:项目根目录 `rustfmt.toml`
104
- - 主要配置:
105
- ```toml
106
- edition = "2021"
107
- max_width = 100
108
- use_small_heuristics = "Max"
109
- ```
110
-
111
- **clippy.toml**(从模板生成):
112
- - 模板位置:`.aodw-next/templates/tools-config/backend/clippy.config.template.toml`
113
- - 生成位置:项目根目录 `clippy.toml` 或 `Cargo.toml` 的 `[lints.clippy]` 部分
114
- - 主要配置:
115
- - 零警告策略:`warn = "all"`, `deny = ["warnings"]`
116
- - 复杂度限制:`cognitive-complexity-threshold = 15`(见模板 `clippy.config.template.toml`)
117
- - 文件长度限制:`too_many_lines_threshold = 400`
118
-
119
- ### 5.3 提交前检查(必须)
120
-
121
- 所有代码提交前必须通过以下检查:
122
- - `cargo fmt -- --check`(代码格式化检查)
123
- - `cargo clippy -- -D warnings`(零警告策略)
124
- - `cargo test`(单元测试)
125
-
126
- 这些检查应配置在 pre-commit hooks 中,确保提交前自动执行。
127
-
128
- ---
129
-
130
- ## 6. 代码质量指标 (Metrics)
131
-
132
- - **函数长度**: 软限制 60 行。超过则拆分。
133
- - **文件长度**: 软限制 400 行。
134
- - **复杂度**: 单个函数 Cyclomatic Complexity < 15。
@@ -1,16 +0,0 @@
1
- # 06-project 目录
2
-
3
- 本目录用于存放项目级别的用户生成文件,初始为空。
4
-
5
- ## 文件说明
6
-
7
- 运行 `aodw-skill init-overview` 后,本目录会自动生成以下文件:
8
-
9
- - `ai-overview.md` - 项目概览文档(技术栈、架构、模块职责等)
10
- - `modules-index.yaml` - 模块索引文件(映射代码目录到模块文档)
11
-
12
- ## 注意事项
13
-
14
- - 这些文件是**用户生成内容**,更新 AODW-Next 时会被保护,不会被覆盖
15
- - 模板文件位于 `../templates/` 目录下
16
- - AI 修改代码前会读取这些文件来理解项目结构
@@ -1,253 +0,0 @@
1
- # AODW Token 消耗分析与优化建议
2
-
3
- ## 1. 问题确认
4
-
5
- 用户反馈使用 AODW 过程中非常消耗 AI 的 token。经过分析,确实存在这个问题。
6
-
7
- ### 1.1 Token 消耗统计
8
-
9
- **总体情况**:
10
- - 规则文件总数:46 个
11
- - 总文件大小:283.3 KB
12
- - 估算总 token:~72,504 tokens
13
-
14
- **典型工作流消耗**:
15
- - **创建新 RT (Spec-Lite)**:~16,338 tokens(6 个文件,63.8 KB)
16
- - **创建新 RT (Spec-Full)**:~24,275 tokens(8 个文件,94.8 KB)
17
- - **UI 相关任务**:~9,055 tokens(7 个文件,35.4 KB)
18
- - **代码实现阶段**:~10,971 tokens(5 个文件,42.9 KB)
19
-
20
- ### 1.2 主要问题
21
-
22
- 1. **强制文件加载过多**
23
- - 每次创建 RT 都需要读取多个大文件(3-8 个)
24
- - UI 任务需要额外读取 4 个 ui-kit 文件
25
- - 审计阶段需要读取大型审计规则文件(17KB+)
26
-
27
- 2. **文件大小问题**
28
- - 最大的文件:18KB+(python-fastapi 编码规范)
29
- - 多个文件超过 10KB
30
- - 审计规则文件特别大(17KB+)
31
-
32
- 3. **重复加载可能性**
33
- - 某些文件被多次引用(如 `ai-coding-rules-common.md` 被引用 15 次)
34
- - 不同阶段可能重复加载相同文件
35
-
36
- 4. **缺乏按需加载机制**
37
- - 规则要求"必须读取",但没有明确"何时读取"
38
- - 没有区分"必须立即读取"和"按需读取"
39
-
40
- ---
41
-
42
- ## 2. 优化建议
43
-
44
- ### 2.1 按需加载策略(推荐)
45
-
46
- **核心原则**:只在需要时读取相关文件,而不是一次性加载所有文件。
47
-
48
- #### 优化方案 A:阶段化加载
49
-
50
- **当前问题**:
51
- - 创建 RT 时一次性加载 6-8 个文件
52
- - 所有文件都在上下文中,即使当前阶段不需要
53
-
54
- **优化方案**:
55
- - **阶段 1(创建 RT)**:只加载 `rt-manager.md`、`ai-interaction-rules.md`、`rt-id-generation-rules.md`
56
- - **阶段 2(Intake)**:按需加载 `ai-interaction-rules.md`(如果未加载)
57
- - **阶段 3(决策)**:按需加载 `spec-full-profile.md` 或 `spec-lite-profile.md`
58
- - **阶段 4(Spec/Plan)**:按需加载相关规范文件
59
- - **阶段 5(实现)**:按需加载编码规范文件
60
- - **阶段 6(审计)**:按需加载审计规则文件
61
-
62
- #### 优化方案 B:摘要索引模式
63
-
64
- **核心思路**:为大型文件创建摘要版本,AI 先读取摘要,需要详细信息时再读取完整文件。
65
-
66
- **实施方式**:
67
- 1. 为每个大型规则文件创建 `xxx-summary.md`(1-2KB)
68
- 2. 摘要包含:核心规则、关键检查点、详细规则位置
69
- 3. AI 先读取摘要,根据摘要决定是否需要读取完整文件
70
-
71
- **示例**:
72
- ```
73
- .aodw-next/02-workflow/spec-lite-profile-summary.md (摘要)
74
- .aodw-next/02-workflow/spec-lite-profile.md (完整版)
75
- ```
76
-
77
- ### 2.2 UI-Kit 优化
78
-
79
- **当前问题**:
80
- - UI 任务需要读取 4 个 ui-kit 文件(~670 tokens)
81
- - 这些文件内容相对简单,可以合并或精简
82
-
83
- **优化方案**:
84
- 1. **合并文件**:将 4 个文件合并为 1 个 `ui-kit.md`(~2KB)
85
- 2. **精简内容**:移除冗余说明,保留核心规则
86
- 3. **按需加载**:只在 UI 任务时加载,非 UI 任务不加载
87
-
88
- ### 2.3 审计规则优化
89
-
90
- **当前问题**:
91
- - 审计规则文件特别大(17KB+,~4,350 tokens)
92
- - 每次审计都需要加载完整文件
93
-
94
- **优化方案**:
95
- 1. **拆分文件**:按审计类型拆分(需求审计、开发审计、综合审计)
96
- 2. **摘要模式**:创建摘要版本,只包含核心检查点
97
- 3. **按需加载**:只在执行审计时加载,不提前加载
98
-
99
- ### 2.4 编码规范优化
100
-
101
- **当前问题**:
102
- - 编码规范文件被频繁引用(15+ 次)
103
- - 文件较大(11KB+)
104
- - 可能在不同阶段重复加载
105
-
106
- **优化方案**:
107
- 1. **缓存机制**:如果已加载过,不再重复加载
108
- 2. **摘要版本**:创建摘要,只包含关键规则
109
- 3. **按技术栈分离**:前端/后端规范分开,只加载相关的
110
-
111
- ### 2.5 规则文件精简
112
-
113
- **当前问题**:
114
- - 某些文件包含大量示例代码和说明
115
- - 可以精简为核心规则
116
-
117
- **优化方案**:
118
- 1. **移除冗余示例**:保留 1-2 个关键示例即可
119
- 2. **精简说明**:移除重复说明,保留核心规则
120
- 3. **外部化示例**:将详细示例移到单独文件
121
-
122
- ---
123
-
124
- ## 3. 实施优先级
125
-
126
- ### 高优先级(立即实施)
127
-
128
- 1. **明确按需加载规则**
129
- - 更新规则文件,明确"何时读取"而不是"必须读取"
130
- - 区分"必须立即读取"和"按需读取"
131
-
132
- 2. **UI-Kit 文件合并**
133
- - 将 4 个文件合并为 1 个
134
- - 精简内容,保留核心规则
135
-
136
- 3. **创建文件加载指南**
137
- - 明确每个阶段需要加载哪些文件
138
- - 避免重复加载
139
-
140
- ### 中优先级(后续优化)
141
-
142
- 4. **创建摘要版本**
143
- - 为大型文件创建摘要版本
144
- - AI 先读取摘要,需要时再读取完整版
145
-
146
- 5. **审计规则拆分**
147
- - 按审计类型拆分文件
148
- - 减少单次加载的文件大小
149
-
150
- 6. **编码规范优化**
151
- - 创建摘要版本
152
- - 实施缓存机制
153
-
154
- ### 低优先级(长期优化)
155
-
156
- 7. **规则文件精简**
157
- - 移除冗余内容
158
- - 外部化详细示例
159
-
160
- 8. **智能加载系统**
161
- - 根据任务类型自动选择需要加载的文件
162
- - 实施文件依赖关系管理
163
-
164
- ---
165
-
166
- ## 4. 具体优化措施
167
-
168
- ### 4.1 更新规则文件,明确加载时机
169
-
170
- **当前表述**:
171
- > AI **必须**先读取并理解以下文件
172
-
173
- **优化后**:
174
- > AI **必须**在 [具体阶段/条件] 时读取并理解以下文件:
175
- > - 如果 [条件 A]:读取文件 X
176
- > - 如果 [条件 B]:读取文件 Y
177
- > - 否则:跳过
178
-
179
- ### 4.2 创建文件加载指南
180
-
181
- 在 `aodw-constitution.md` 中添加"文件加载策略"章节,明确:
182
- - 每个阶段需要加载哪些文件
183
- - 哪些文件可以按需加载
184
- - 哪些文件可以缓存
185
-
186
- ### 4.3 优化 UI-Kit 文件
187
-
188
- - 合并 4 个文件为 1 个 `ui-kit.md`
189
- - 精简内容,保留核心规则
190
- - 总大小控制在 2KB 以内
191
-
192
- ---
193
-
194
- ## 5. 预期效果
195
-
196
- 实施优化后,预期可以:
197
-
198
- 1. **减少 50-70% 的 token 消耗**
199
- - Spec-Lite RT 创建:从 ~16K tokens 降至 ~5-8K tokens
200
- - Spec-Full RT 创建:从 ~24K tokens 降至 ~8-12K tokens
201
- - UI 任务:从 ~9K tokens 降至 ~2-3K tokens
202
-
203
- 2. **提升响应速度**
204
- - 减少文件加载时间
205
- - 减少上下文处理时间
206
-
207
- 3. **保持功能完整性**
208
- - 所有核心功能保持不变
209
- - 只是优化了加载策略
210
-
211
- ---
212
-
213
- ## 6. 风险评估
214
-
215
- ### 6.1 潜在风险
216
-
217
- 1. **按需加载可能导致遗漏**
218
- - 风险:AI 可能忘记在需要时加载文件
219
- - 缓解:明确的加载指南和检查清单
220
-
221
- 2. **摘要版本可能信息不足**
222
- - 风险:摘要可能遗漏关键信息
223
- - 缓解:摘要包含完整文件的引用,需要时可读取
224
-
225
- 3. **用户学习成本**
226
- - 风险:新的加载策略需要用户理解
227
- - 缓解:提供清晰的文档和示例
228
-
229
- ### 6.2 兼容性
230
-
231
- - 优化后的规则应该向后兼容
232
- - 支持"完整加载"和"按需加载"两种模式
233
- - 用户可以选择使用哪种模式
234
-
235
- ---
236
-
237
- ## 7. 下一步行动
238
-
239
- 1. **立即行动**:
240
- - 更新规则文件,明确加载时机
241
- - 合并 UI-Kit 文件
242
- - 创建文件加载指南
243
-
244
- 2. **短期行动**(1-2 周):
245
- - 创建摘要版本
246
- - 优化审计规则
247
- - 实施缓存机制
248
-
249
- 3. **长期行动**(1 个月+):
250
- - 规则文件精简
251
- - 智能加载系统
252
- - 性能监控和优化
253
-
@@ -1,110 +0,0 @@
1
- # 模板应用指南 (Template Application Guide)
2
-
3
- ## 1. 模板机制概述
4
-
5
- AODW Next 使用**统一模板机制**来生成各个平台的适配器文件,确保所有平台的内容保持一致。
6
-
7
- ### 1.1 模板位置
8
-
9
- **源模板**:`.aodw-next/templates/aodw-kernel-loader-template.md`
10
-
11
- 这个模板包含所有平台的通用内容,使用占位符标记平台差异:
12
- - `{{REF_PREFIX}}` - 引用前缀(Cursor: `@`,其他: 空)
13
-
14
- ### 1.2 适配器文件位置
15
-
16
- **生成的适配器文件**(在源仓库中):
17
- - `templates/AODW_Adapters/antigravity/.agent/rules/aodw-next.md`
18
- - `templates/AODW_Adapters/cursor/.cursor/rules/aodw-next.mdc`
19
- - `templates/AODW_Adapters/claude/CLAUDE.md`
20
- - `templates/AODW_Adapters/gemini/.agent/rules/aodw-next.md`
21
- - `templates/AODW_Adapters/general/AGENTS.md`
22
-
23
- **注意**:适配器文件在用户项目中安装到对应位置。
24
-
25
- ---
26
-
27
- ## 2. 模板处理流程
28
-
29
- ### 2.1 安装阶段(用户项目)
30
-
31
- 1. **CLI 检测模板**:检查 `.aodw-next/templates/aodw-kernel-loader-template.md` 是否存在
32
- 2. **使用 Processor**:根据平台选择对应的 Processor
33
- 3. **生成适配器文件**:在用户项目中生成适配器文件
34
-
35
- **Processor 处理**:
36
- - **AntigravityProcessor**:替换 `{{REF_PREFIX}}` 为空,注入 `trigger: always_on`
37
- - **CursorProcessor**:替换 `{{REF_PREFIX}}` 为 `@`,注入 frontmatter(globs, alwaysApply 等)
38
- - **ClaudeProcessor**:替换 `{{REF_PREFIX}}` 为空
39
- - **GeminiProcessor**:替换 `{{REF_PREFIX}}` 为空
40
- - **GeneralProcessor**:替换 `{{REF_PREFIX}}` 为空
41
-
42
- ---
43
-
44
- ## 3. Processor 说明
45
-
46
- ### 3.1 AntigravityProcessor
47
-
48
- **处理**:
49
- - 替换 `{{REF_PREFIX}}` 为空字符串
50
- - 注入 `trigger: always_on` frontmatter(仅对 kernel loader)
51
-
52
- **输出**:
53
- - 文件:`templates/AODW_Adapters/antigravity/.agent/rules/aodw-next.md`
54
- - 格式:Markdown with frontmatter
55
-
56
- ### 3.2 CursorProcessor
57
-
58
- **处理**:
59
- - 替换 `{{REF_PREFIX}}` 为 `@`
60
- - 注入 frontmatter:`globs: *`, `alwaysApply: true`, `description`, `tags`
61
- - 文件扩展名改为 `.mdc`
62
-
63
- **输出**:
64
- - 文件:`templates/AODW_Adapters/cursor/.cursor/rules/aodw-next.mdc`
65
- - 格式:Markdown with Cursor-specific frontmatter
66
-
67
- ### 3.3 ClaudeProcessor
68
-
69
- **处理**:
70
- - 替换 `{{REF_PREFIX}}` 为空字符串
71
- - 不注入 frontmatter
72
-
73
- **输出**:
74
- - 文件:`templates/AODW_Adapters/claude/CLAUDE.md`
75
- - 格式:标准 Markdown
76
-
77
- ### 3.4 GeminiProcessor
78
-
79
- **处理**:
80
- - 替换 `{{REF_PREFIX}}` 为空字符串
81
- - 不注入 frontmatter
82
-
83
- **输出**:
84
- - 文件:`templates/AODW_Adapters/gemini/.agent/rules/aodw-next.md`
85
- - 格式:标准 Markdown
86
-
87
- ### 3.5 GeneralProcessor
88
-
89
- **处理**:
90
- - 替换 `{{REF_PREFIX}}` 为空字符串
91
- - 不注入 frontmatter
92
-
93
- **输出**:
94
- - 文件:`templates/AODW_Adapters/general/AGENTS.md`
95
- - 格式:标准 Markdown
96
-
97
- ---
98
-
99
- ## 4. 相关文件
100
-
101
- - **模板文件**:`.aodw-next/templates/aodw-kernel-loader-template.md`
102
- - **Processor 实现**:`cli/bin/processors/index.js`
103
- - **CLI 安装脚本**:`cli/bin/aodw.js`
104
- - **适配器文件**:`templates/AODW_Adapters/`
105
-
106
- ---
107
-
108
- ## 5. 版本历史
109
-
110
- - **v4.0.0**:AODW Next,统一使用 `.aodw-next` 目录