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,13 +0,0 @@
|
|
|
1
|
-
# Spec-Full Profile Summary
|
|
2
|
-
|
|
3
|
-
## 适用场景
|
|
4
|
-
- 跨模块、大改动、高风险、数据模型/合约变更
|
|
5
|
-
|
|
6
|
-
## 必备文档
|
|
7
|
-
- spec.md / plan.md / impact.md / invariants.md / tests.md / changelog.md
|
|
8
|
-
- 需要时补充 research / data-model / contracts
|
|
9
|
-
|
|
10
|
-
## 关键要求
|
|
11
|
-
- spec 完成后必须执行需求审计
|
|
12
|
-
- plan 完成后必须等待用户确认
|
|
13
|
-
- UI 任务需走 UI 专用流程
|
|
@@ -1,116 +0,0 @@
|
|
|
1
|
-
# AI System Overview
|
|
2
|
-
(本文件列出 AI 理解本系统所需的全局信息)
|
|
3
|
-
|
|
4
|
-
> 说明:本文件是骨架模板,AI 可以在后续 RT 中逐步补全。
|
|
5
|
-
> 修改架构或模块职责时,AI 必须同步更新本文件。
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. 技术栈
|
|
10
|
-
|
|
11
|
-
- 前端:
|
|
12
|
-
- 后端:
|
|
13
|
-
- 数据库:
|
|
14
|
-
- 消息系统:
|
|
15
|
-
- 缓存:
|
|
16
|
-
- 运维 / 部署:
|
|
17
|
-
- 其他:
|
|
18
|
-
|
|
19
|
-
(由 AI 或人工在首次接入 AODW 时填写,后续在架构变动时更新)
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## 2. 整体架构概览
|
|
24
|
-
|
|
25
|
-
可以使用文字或 ASCII 图描述系统架构,例如:
|
|
26
|
-
|
|
27
|
-
```text
|
|
28
|
-
[ Web / Mobile Client ]
|
|
29
|
-
|
|
|
30
|
-
[ API ]
|
|
31
|
-
|
|
|
32
|
-
[ Services / Domain ]
|
|
33
|
-
|
|
|
34
|
-
[ DB / MQ ]
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
AI 应在理解架构后,将关键组件简要记录在此处。
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## 3. 目录结构(只列关键部分)
|
|
42
|
-
|
|
43
|
-
请根据实际项目补充,例如:
|
|
44
|
-
|
|
45
|
-
- `/apps/web` - 前端应用
|
|
46
|
-
- `/apps/api` - 后端 API
|
|
47
|
-
- `/packages/shared` - 共享代码(类型、工具等)
|
|
48
|
-
- `/infra` - 基础设施与部署脚本
|
|
49
|
-
- `/RT` - 每个 Request Ticket 的本地知识库
|
|
50
|
-
- `/aodw` - AODW 配置与规则文件(本目录)
|
|
51
|
-
|
|
52
|
-
AI 在修改目录结构时,需要在此更新说明。
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## 4. 核心业务模块
|
|
57
|
-
|
|
58
|
-
为每个重要业务模块列出简要说明(AI 可从模块 README 中提取信息汇总到这里)。
|
|
59
|
-
|
|
60
|
-
示例模板:
|
|
61
|
-
|
|
62
|
-
### 4.1 用户模块(User Module)
|
|
63
|
-
|
|
64
|
-
- **职责**:认证、授权、用户资料管理等
|
|
65
|
-
- **关键路径**:
|
|
66
|
-
- Web UI:`apps/web/src/features/user/...`
|
|
67
|
-
- API:`apps/api/src/users/...`
|
|
68
|
-
- **依赖关系**:
|
|
69
|
-
- 调用:订单模块、通知模块等
|
|
70
|
-
- 被调用:认证中间件等
|
|
71
|
-
- **关键约束**:
|
|
72
|
-
- 不得在 controller 中直接访问数据库,必须通过 service / repository 层;
|
|
73
|
-
- 密码与敏感字段必须加密或脱敏。
|
|
74
|
-
|
|
75
|
-
### 4.2 订单模块(Order Module)
|
|
76
|
-
|
|
77
|
-
(同样结构)
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## 5. 系统级 Invariants(不可破坏原则)
|
|
82
|
-
|
|
83
|
-
AI 在修改任何代码前必须确认不会违反以下约束:
|
|
84
|
-
|
|
85
|
-
- 不得绕过 service 层直接访问 DB;
|
|
86
|
-
- 不得无故更改对外 API 返回格式(除非走 Spec-Full 流程);
|
|
87
|
-
- 不得在热路径引入明显的性能退化;
|
|
88
|
-
- 不得引入明显的安全风险(如绕过认证、明文敏感信息)。
|
|
89
|
-
|
|
90
|
-
根据系统演进,这些 Invariants 可以在 RT 中进行讨论与更新。
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
## 6. 模块 README 映射表
|
|
95
|
-
|
|
96
|
-
为 AI 提供“代码目录 → 模块文档”的索引示例:
|
|
97
|
-
|
|
98
|
-
```text
|
|
99
|
-
apps/api/src/users/** → docs/modules/users.md
|
|
100
|
-
apps/api/src/orders/** → docs/modules/orders.md
|
|
101
|
-
apps/web/src/features/** → docs/modules/web-features.md
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
AI 在创建新模块或重构模块结构时,应同步维护此映射关系。
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## 7. 历史关键变更(可选)
|
|
109
|
-
|
|
110
|
-
可记录一些对架构或业务影响较大的里程碑,例如:
|
|
111
|
-
|
|
112
|
-
- 2025-01:引入新订单系统;
|
|
113
|
-
- 2025-03:从单体拆分为微服务;
|
|
114
|
-
- 2025-05:迁移认证机制到 OAuth2。
|
|
115
|
-
|
|
116
|
-
这些信息便于 AI 理解系统随时间的演进。
|
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
# 编码规范融入 AODW - 发布前检查清单
|
|
2
|
-
|
|
3
|
-
## ✅ 最终检查结果
|
|
4
|
-
|
|
5
|
-
### 1. 核心流程文档修改 ✅
|
|
6
|
-
|
|
7
|
-
- [x] **spec-full-profile.md**
|
|
8
|
-
- [x] Plan 模板添加"代码结构与分层设计"章节(第 4 节)
|
|
9
|
-
- [x] 添加"开发阶段要求"章节(第 6 节)
|
|
10
|
-
- [x] checklists 部分添加编码规范验收项
|
|
11
|
-
- [x] 已同步到 `templates/.aodw/02-workflow/spec-full-profile.md`
|
|
12
|
-
|
|
13
|
-
- [x] **spec-lite-profile.md**
|
|
14
|
-
- [x] Plan-Lite 模板添加"代码结构与分层设计"章节(第 3 节)
|
|
15
|
-
- [x] 流程中添加开发准备、开发过程中、开发结束前自检要求
|
|
16
|
-
- [x] 已同步到 `templates/.aodw/02-workflow/spec-lite-profile.md`
|
|
17
|
-
|
|
18
|
-
- [x] **git-discipline.md**
|
|
19
|
-
- [x] 添加"合并前检查清单"章节(第 5 节)
|
|
20
|
-
- [x] 编码规范检查作为合并的硬性要求
|
|
21
|
-
- [x] 自动化检查中添加编码规范检查(Step 2)
|
|
22
|
-
- [x] 已同步到 `templates/.aodw/01-core/git-discipline.md`
|
|
23
|
-
|
|
24
|
-
- [x] **rt-manager.md**
|
|
25
|
-
- [x] Intake 流程中添加技术约束要求(第 180 行)
|
|
26
|
-
- [x] 已同步到 `templates/.aodw/02-workflow/rt-manager.md`
|
|
27
|
-
|
|
28
|
-
### 2. 模板文件修改 ✅
|
|
29
|
-
|
|
30
|
-
- [x] **rt-intake-template.md**
|
|
31
|
-
- [x] 添加"相关技术约束/规范"字段(第 6 节,可选)
|
|
32
|
-
- [x] 已同步到 `templates/.aodw/templates/rt-intake-template.md`
|
|
33
|
-
|
|
34
|
-
- [x] **coding-standards-template.md**(新建)
|
|
35
|
-
- [x] 创建编码规范验收清单模板(103 行)
|
|
36
|
-
- [x] 包含前端、后端、通用编码规范验收项
|
|
37
|
-
- [x] 已同步到 `templates/.aodw/templates/checklists/coding-standards-template.md`
|
|
38
|
-
|
|
39
|
-
### 3. 文件同步验证 ✅
|
|
40
|
-
|
|
41
|
-
- [x] 所有核心流程文档已同步到模板目录
|
|
42
|
-
- [x] 所有模板文件已同步到模板目录
|
|
43
|
-
- [x] 新建的 checklists 目录已创建并同步
|
|
44
|
-
|
|
45
|
-
### 4. 内容完整性验证 ✅
|
|
46
|
-
|
|
47
|
-
- [x] Plan 模板包含完整的代码结构与分层设计内容
|
|
48
|
-
- [x] 开发阶段要求包含完整的检查清单
|
|
49
|
-
- [x] 合并前检查清单包含完整的编码规范检查项
|
|
50
|
-
- [x] Intake 模板包含技术约束字段
|
|
51
|
-
|
|
52
|
-
### 5. 引用路径验证 ✅
|
|
53
|
-
|
|
54
|
-
- [x] 所有编码规范文件引用路径正确(`.aodw/ai-coding-rules-*.md`)
|
|
55
|
-
- [x] 模板文件引用路径正确(`.aodw/templates/checklists/coding-standards-template.md`)
|
|
56
|
-
|
|
57
|
-
### 6. 格式和语法验证 ✅
|
|
58
|
-
|
|
59
|
-
- [x] Markdown 格式正确
|
|
60
|
-
- [x] 标题层级正确
|
|
61
|
-
- [x] 列表格式正确
|
|
62
|
-
- [x] 代码块格式正确
|
|
63
|
-
- [x] 无 Linter 错误
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## 📋 修改文件清单
|
|
68
|
-
|
|
69
|
-
### 核心流程文档(4 个文件)
|
|
70
|
-
1. ✅ `.aodw/02-workflow/spec-full-profile.md` → `templates/.aodw/02-workflow/spec-full-profile.md`
|
|
71
|
-
2. ✅ `.aodw/02-workflow/spec-lite-profile.md` → `templates/.aodw/02-workflow/spec-lite-profile.md`
|
|
72
|
-
3. ✅ `.aodw/01-core/git-discipline.md` → `templates/.aodw/01-core/git-discipline.md`
|
|
73
|
-
4. ✅ `.aodw/02-workflow/rt-manager.md` → `templates/.aodw/02-workflow/rt-manager.md`
|
|
74
|
-
|
|
75
|
-
### 模板文件(2 个文件)
|
|
76
|
-
5. ✅ `.aodw/templates/rt-intake-template.md` → `templates/.aodw/templates/rt-intake-template.md`
|
|
77
|
-
6. ✅ `.aodw/templates/checklists/coding-standards-template.md`(新建)→ `templates/.aodw/templates/checklists/coding-standards-template.md`
|
|
78
|
-
|
|
79
|
-
### 其他相关文件(已存在,本次未修改)
|
|
80
|
-
- `.aodw/03-standards/ai-coding-rules.md`(已包含按需加载机制)
|
|
81
|
-
- `.aodw/03-standards/stacks/react-typescript/ai-coding-rules-frontend.md`(已存在)
|
|
82
|
-
- `.aodw/03-standards/stacks/python-fastapi/ai-coding-rules-backend.md`(已存在)
|
|
83
|
-
- `.aodw/03-standards/ai-coding-rules-common.md`(已存在)
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## 🎯 融入效果确认
|
|
88
|
-
|
|
89
|
-
### ✅ 方案设计阶段
|
|
90
|
-
- Plan 模板强制要求代码结构与分层设计
|
|
91
|
-
- 编码规范符合性说明作为必填项
|
|
92
|
-
- 防止"想到哪里写到哪里"
|
|
93
|
-
|
|
94
|
-
### ✅ 开发阶段
|
|
95
|
-
- 开发准备要求工具初始化和编码规范加载
|
|
96
|
-
- 开发过程中要求遵守编码规范
|
|
97
|
-
- 开发结束前要求自检
|
|
98
|
-
|
|
99
|
-
### ✅ 提交/合并阶段
|
|
100
|
-
- 编码规范检查作为合并的硬性要求
|
|
101
|
-
- 未通过编码规范检查的代码不能合并
|
|
102
|
-
- 确保代码质量
|
|
103
|
-
|
|
104
|
-
### ✅ 测试/验收阶段
|
|
105
|
-
- 编码规范验收清单模板已创建
|
|
106
|
-
- 可作为补充验收项使用
|
|
107
|
-
|
|
108
|
-
### ✅ 需求分析阶段
|
|
109
|
-
- 技术约束字段已添加(可选)
|
|
110
|
-
- AI 根据情况填写
|
|
111
|
-
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
## ✅ 最终结论
|
|
115
|
-
|
|
116
|
-
**所有检查通过,可以提交新版本**
|
|
117
|
-
|
|
118
|
-
编码规范已成功融入 AODW 的各个关键节点:
|
|
119
|
-
- ✅ 不再是"挂一个子流程",而是"嵌入到主流程的每个节点"
|
|
120
|
-
- ✅ 编码规范成为流程的必经步骤
|
|
121
|
-
- ✅ 编码规范成为质量门槛
|
|
122
|
-
- ✅ 编码规范从设计阶段就开始参与
|
|
123
|
-
|
|
124
|
-
所有文件已正确修改并同步到模板目录,可以提交新版本。
|
|
125
|
-
|
|
126
|
-
---
|
|
127
|
-
|
|
128
|
-
## 📝 提交建议
|
|
129
|
-
|
|
130
|
-
建议提交信息:
|
|
131
|
-
```
|
|
132
|
-
feat(aodw): 将编码规范融入 AODW 各阶段流程
|
|
133
|
-
|
|
134
|
-
- 在 Plan 模板中添加代码结构与分层设计章节(必须)
|
|
135
|
-
- 在开发阶段添加编码规范要求(必须)
|
|
136
|
-
- 在合并前检查清单中添加编码规范检查(必须)
|
|
137
|
-
- 创建编码规范验收清单模板(可选)
|
|
138
|
-
- 在 Intake 模板中添加技术约束字段(可选)
|
|
139
|
-
|
|
140
|
-
编码规范已从"子流程"转变为"主流程的必经步骤",
|
|
141
|
-
确保代码质量从设计阶段就开始参与。
|
|
142
|
-
|
|
143
|
-
Refs: [RT-ID]
|
|
144
|
-
```
|
|
@@ -1,276 +0,0 @@
|
|
|
1
|
-
# 源文件到分发版本同步指南
|
|
2
|
-
|
|
3
|
-
## 1. 目录关系说明
|
|
4
|
-
|
|
5
|
-
AODW 项目中有三个 `.aodw` 目录,它们的关系如下:
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
项目根目录/
|
|
9
|
-
├── .aodw/ ← 【源文件】Source of Truth(开发者在这里修改)
|
|
10
|
-
│ ├── aodw-constitution.md
|
|
11
|
-
│ ├── rt-manager.md
|
|
12
|
-
│ └── ...
|
|
13
|
-
│
|
|
14
|
-
├── templates/
|
|
15
|
-
│ └── .aodw/ ← 【分发版本】Distribution Version(打包到 CLI 安装包)
|
|
16
|
-
│ ├── aodw-constitution.md
|
|
17
|
-
│ ├── rt-manager.md
|
|
18
|
-
│ └── ...
|
|
19
|
-
│
|
|
20
|
-
└── cli/
|
|
21
|
-
└── .aodw/ ← 【本地构建版本】Local Build(用于本地测试)
|
|
22
|
-
├── aodw-constitution.md
|
|
23
|
-
├── rt-manager.md
|
|
24
|
-
└── ...
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
### 1.1 根目录 `.aodw`(源文件)
|
|
28
|
-
|
|
29
|
-
**位置**:项目根目录的 `.aodw/`
|
|
30
|
-
|
|
31
|
-
**作用**:
|
|
32
|
-
- **源文件(Source of Truth)**
|
|
33
|
-
- 开发者在这里修改和开发
|
|
34
|
-
- 这是唯一应该手动编辑的目录
|
|
35
|
-
|
|
36
|
-
**包含内容**:
|
|
37
|
-
- 所有 AODW 核心规则文件
|
|
38
|
-
- 模板文件
|
|
39
|
-
- 开发文档
|
|
40
|
-
|
|
41
|
-
### 1.2 `templates/.aodw`(分发版本)
|
|
42
|
-
|
|
43
|
-
**位置**:`templates/.aodw/`
|
|
44
|
-
|
|
45
|
-
**作用**:
|
|
46
|
-
- **分发版本(Distribution Version)**
|
|
47
|
-
- 用于打包到 CLI 安装包(npm 包)
|
|
48
|
-
- 用户安装时,CLI 会从这个目录复制文件到用户项目
|
|
49
|
-
|
|
50
|
-
**来源**:
|
|
51
|
-
- 从根目录 `.aodw` 同步而来
|
|
52
|
-
- **不应该**直接在这个目录修改
|
|
53
|
-
|
|
54
|
-
### 1.3 `cli/.aodw`(本地构建版本)
|
|
55
|
-
|
|
56
|
-
**位置**:`cli/.aodw/`
|
|
57
|
-
|
|
58
|
-
**作用**:
|
|
59
|
-
- **本地构建版本(Local Build)**
|
|
60
|
-
- 用于本地测试 CLI
|
|
61
|
-
- 运行 `cli/build-local.sh` 时会从 `templates/.aodw` 复制到这里
|
|
62
|
-
|
|
63
|
-
**来源**:
|
|
64
|
-
- 从 `templates/.aodw` 复制而来
|
|
65
|
-
- **不应该**直接在这个目录修改
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
## 2. 文件同步流程
|
|
70
|
-
|
|
71
|
-
### 2.1 开发流程
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
开发者修改
|
|
75
|
-
↓
|
|
76
|
-
根目录 .aodw/ ← 【源文件】Source of Truth
|
|
77
|
-
↓
|
|
78
|
-
运行同步脚本
|
|
79
|
-
↓
|
|
80
|
-
templates/.aodw/ ← 【分发版本】Distribution Version
|
|
81
|
-
↓
|
|
82
|
-
运行构建脚本(可选)
|
|
83
|
-
↓
|
|
84
|
-
cli/.aodw/ ← 【本地构建版本】Local Build(用于测试)
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### 2.2 发布流程
|
|
88
|
-
|
|
89
|
-
```
|
|
90
|
-
根目录 .aodw/ ← 【源文件】
|
|
91
|
-
↓
|
|
92
|
-
publish.sh 自动同步
|
|
93
|
-
↓
|
|
94
|
-
templates/.aodw/ ← 【分发版本】
|
|
95
|
-
↓
|
|
96
|
-
publish.sh 复制到 CLI
|
|
97
|
-
↓
|
|
98
|
-
cli/.aodw/ ← 【打包到 npm】
|
|
99
|
-
↓
|
|
100
|
-
npm publish
|
|
101
|
-
↓
|
|
102
|
-
用户安装
|
|
103
|
-
↓
|
|
104
|
-
用户项目的 .aodw/ ← 【用户项目】
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
> **双版本发布**:`publish.sh` 会根据当前分支自动选择发布渠道
|
|
108
|
-
> - `release/next` 或包含 `-next` 的分支 → 发布 `aodw-skill`
|
|
109
|
-
> - 其他分支 → 发布 `aodw`
|
|
110
|
-
> - next 渠道使用独立模板目录:`templates/.aodw-next`、`templates/AODW_Adapters_next`、`templates/docs-next`
|
|
111
|
-
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
## 3. 如何同步文件
|
|
115
|
-
|
|
116
|
-
### 3.1 手动同步(推荐)
|
|
117
|
-
|
|
118
|
-
运行同步脚本:
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
# 在项目根目录运行
|
|
122
|
-
./sync-templates.sh
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
这个脚本会:
|
|
126
|
-
1. 将根目录 `.aodw` 复制到 `templates/.aodw`
|
|
127
|
-
2. 将根目录 `docs` 复制到 `templates/docs`
|
|
128
|
-
3. 更新适配器文件(从模板生成)
|
|
129
|
-
|
|
130
|
-
### 3.2 自动同步(发布时)
|
|
131
|
-
|
|
132
|
-
`publish.sh` 脚本会自动同步:
|
|
133
|
-
|
|
134
|
-
```bash
|
|
135
|
-
# 在 cli 目录运行
|
|
136
|
-
cd cli
|
|
137
|
-
./publish.sh patch # 或 minor, major
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
发布脚本会:
|
|
141
|
-
1. 自动从根目录 `.aodw` 同步到 `templates/.aodw`
|
|
142
|
-
2. 从 `templates/.aodw` 复制到 `cli/.aodw`
|
|
143
|
-
3. 打包并发布到 npm
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
## 4. 最佳实践
|
|
148
|
-
|
|
149
|
-
### 4.1 开发时
|
|
150
|
-
|
|
151
|
-
1. ✅ **只在根目录 `.aodw` 修改文件**
|
|
152
|
-
2. ✅ **修改后运行同步脚本**:`./sync-templates.sh`
|
|
153
|
-
3. ✅ **提交更改**:包括根目录 `.aodw` 和 `templates/.aodw`
|
|
154
|
-
|
|
155
|
-
### 4.2 发布前
|
|
156
|
-
|
|
157
|
-
1. ✅ **确保已同步**:运行 `./sync-templates.sh`
|
|
158
|
-
2. ✅ **检查 templates/.aodw**:确保包含最新更改
|
|
159
|
-
3. ✅ **运行发布脚本**:`cd cli && ./publish.sh [patch|minor|major]`
|
|
160
|
-
|
|
161
|
-
### 4.3 本地测试
|
|
162
|
-
|
|
163
|
-
1. ✅ **运行构建脚本**:`cd cli && ./build-local.sh`
|
|
164
|
-
2. ✅ **测试 CLI**:`cd cli && node bin/aodw.js init`
|
|
165
|
-
3. ✅ **验证文件**:检查生成的文件是否正确
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## 5. 常见问题
|
|
170
|
-
|
|
171
|
-
### 5.1 为什么有两个 .aodw 目录?
|
|
172
|
-
|
|
173
|
-
**原因**:
|
|
174
|
-
- **根目录 `.aodw`**:源文件,开发者在这里修改
|
|
175
|
-
- **`templates/.aodw`**:分发版本,用于打包
|
|
176
|
-
|
|
177
|
-
**好处**:
|
|
178
|
-
- 清晰的职责分离
|
|
179
|
-
- 源文件和分发版本分离
|
|
180
|
-
- 便于版本控制和发布管理
|
|
181
|
-
|
|
182
|
-
### 5.2 我修改了根目录的 .aodw,但用户安装的还是旧版本
|
|
183
|
-
|
|
184
|
-
**原因**:
|
|
185
|
-
- 没有同步到 `templates/.aodw`
|
|
186
|
-
- 发布时使用的是旧的 `templates/.aodw`
|
|
187
|
-
|
|
188
|
-
**解决**:
|
|
189
|
-
1. 运行 `./sync-templates.sh` 同步文件
|
|
190
|
-
2. 提交更改
|
|
191
|
-
3. 重新发布
|
|
192
|
-
|
|
193
|
-
### 5.3 可以直接修改 templates/.aodw 吗?
|
|
194
|
-
|
|
195
|
-
**不推荐**:
|
|
196
|
-
- `templates/.aodw` 应该从根目录 `.aodw` 同步而来
|
|
197
|
-
- 直接修改会导致源文件和分发版本不一致
|
|
198
|
-
- 下次同步时会覆盖你的修改
|
|
199
|
-
|
|
200
|
-
**正确做法**:
|
|
201
|
-
- 在根目录 `.aodw` 修改
|
|
202
|
-
- 运行同步脚本
|
|
203
|
-
- 提交更改
|
|
204
|
-
|
|
205
|
-
### 5.4 如何确保打包的是最新版本?
|
|
206
|
-
|
|
207
|
-
**检查清单**:
|
|
208
|
-
1. ✅ 根目录 `.aodw` 包含最新更改
|
|
209
|
-
2. ✅ 运行了 `./sync-templates.sh`
|
|
210
|
-
3. ✅ `templates/.aodw` 包含最新更改
|
|
211
|
-
4. ✅ 提交了所有更改
|
|
212
|
-
5. ✅ 运行了 `cd cli && ./publish.sh`
|
|
213
|
-
|
|
214
|
-
---
|
|
215
|
-
|
|
216
|
-
## 6. 同步脚本说明
|
|
217
|
-
|
|
218
|
-
### 6.1 sync-templates.sh
|
|
219
|
-
|
|
220
|
-
**位置**:项目根目录的 `sync-templates.sh`
|
|
221
|
-
|
|
222
|
-
**功能**:
|
|
223
|
-
1. 同步 `.aodw` 目录:根目录 → `templates/.aodw`
|
|
224
|
-
2. 同步 `docs` 目录:根目录 → `templates/docs`
|
|
225
|
-
3. 更新适配器文件:从模板生成适配器文件
|
|
226
|
-
|
|
227
|
-
**使用方法**:
|
|
228
|
-
```bash
|
|
229
|
-
# 在项目根目录运行
|
|
230
|
-
./sync-templates.sh
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
### 6.2 publish.sh
|
|
234
|
-
|
|
235
|
-
**位置**:`cli/publish.sh`
|
|
236
|
-
|
|
237
|
-
**功能**:
|
|
238
|
-
1. 自动同步根目录 `.aodw` → `templates/.aodw`
|
|
239
|
-
2. 自动同步根目录 `docs` → `templates/docs`
|
|
240
|
-
3. 复制 `templates/.aodw` → `cli/.aodw`
|
|
241
|
-
4. 打包并发布到 npm
|
|
242
|
-
|
|
243
|
-
**使用方法**:
|
|
244
|
-
```bash
|
|
245
|
-
cd cli
|
|
246
|
-
./publish.sh patch # 或 minor, major
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
---
|
|
250
|
-
|
|
251
|
-
## 7. 文件同步检查清单
|
|
252
|
-
|
|
253
|
-
在发布前,确保:
|
|
254
|
-
|
|
255
|
-
- [ ] 根目录 `.aodw` 包含所有最新更改
|
|
256
|
-
- [ ] 运行了 `./sync-templates.sh`
|
|
257
|
-
- [ ] `templates/.aodw` 与根目录 `.aodw` 一致
|
|
258
|
-
- [ ] 适配器文件已更新(从模板生成)
|
|
259
|
-
- [ ] 所有更改已提交到 Git
|
|
260
|
-
- [ ] 运行了 `cd cli && ./publish.sh`
|
|
261
|
-
|
|
262
|
-
---
|
|
263
|
-
|
|
264
|
-
## 8. 相关文件
|
|
265
|
-
|
|
266
|
-
- **同步脚本**:`sync-templates.sh`(项目根目录)
|
|
267
|
-
- **发布脚本**:`cli/publish.sh`
|
|
268
|
-
- **构建脚本**:`cli/build-local.sh`
|
|
269
|
-
- **更新适配器脚本**:`cli/bin/update-adapters-from-template.js`
|
|
270
|
-
|
|
271
|
-
---
|
|
272
|
-
|
|
273
|
-
## 9. 版本历史
|
|
274
|
-
|
|
275
|
-
- **v4.0.0**:引入源文件到分发版本的同步机制
|
|
276
|
-
- **v4.0.1**:添加同步脚本和文档
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
# AODW Workflow Guide (Level 2)
|
|
2
|
-
|
|
3
|
-
本文件为 AODW 的核心流程指令层,用于在触发任务时快速加载。
|
|
4
|
-
|
|
5
|
-
## 1. 核心流程(RT 生命周期)
|
|
6
|
-
|
|
7
|
-
created → intakeing → decided → in-progress → reviewing → done
|
|
8
|
-
|
|
9
|
-
关键动作:
|
|
10
|
-
- **Intake**:澄清范围、风险、模块影响,记录到 `intake.md`
|
|
11
|
-
- **Decision**:选择 Spec-Full / Spec-Lite,并记录到 `decision.md`
|
|
12
|
-
- **Plan**:先写 plan,获批后进入实现
|
|
13
|
-
|
|
14
|
-
## 2. Spec-Full vs Spec-Lite 决策
|
|
15
|
-
|
|
16
|
-
使用 Spec-Full:
|
|
17
|
-
- 跨模块影响
|
|
18
|
-
- 数据模型 / schema 变更
|
|
19
|
-
- 外部 API 合约变更
|
|
20
|
-
- 高风险或高复杂度变更
|
|
21
|
-
|
|
22
|
-
使用 Spec-Lite:
|
|
23
|
-
- 局部改动
|
|
24
|
-
- 单模块小修复
|
|
25
|
-
- 无外部 API 合约变化
|
|
26
|
-
|
|
27
|
-
## 3. Gate 检查点
|
|
28
|
-
|
|
29
|
-
- Gate 1:Intake 澄清完成
|
|
30
|
-
- Gate 2:分支确认(必须在 feature 分支)
|
|
31
|
-
- Gate 3:Plan 确认(未批准不得实现)
|
|
32
|
-
- Gate 4:提交前确认(展示 diff 与 status)
|
|
33
|
-
- Gate 5:完成确认(文档与测试齐备)
|
|
34
|
-
|
|
35
|
-
## 4. 加载策略(渐进式披露)
|
|
36
|
-
|
|
37
|
-
优先读取:
|
|
38
|
-
1. `.aodw/manifest.yaml`(规则索引)
|
|
39
|
-
2. 本文件(流程指令)
|
|
40
|
-
3. 必要规则文件(优先摘要 `*-summary.md`)
|
|
41
|
-
|
|
42
|
-
摘要策略:
|
|
43
|
-
- 先读 `*-summary.md`
|
|
44
|
-
- 需要细节再读完整文件
|
|
45
|
-
|
|
46
|
-
## 5. 关键文件入口
|
|
47
|
-
|
|
48
|
-
- 规则索引:`.aodw/manifest.yaml`
|
|
49
|
-
- RT 流程:`.aodw/02-workflow/rt-manager.md`
|
|
50
|
-
- Spec-Full:`.aodw/02-workflow/spec-full-profile.md`
|
|
51
|
-
- Spec-Lite:`.aodw/02-workflow/spec-lite-profile.md`
|