@chongyan/autospec 1.0.1

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 (243) hide show
  1. package/LICENSE +21 -0
  2. package/README.en.md +472 -0
  3. package/README.md +476 -0
  4. package/bin/autospec.js +3 -0
  5. package/knowledge/README.md +144 -0
  6. package/knowledge/checklists/code.md +182 -0
  7. package/knowledge/checklists/design.md +196 -0
  8. package/knowledge/checklists/release.md +70 -0
  9. package/knowledge/checklists/requirement.md +169 -0
  10. package/knowledge/checklists/test.md +46 -0
  11. package/knowledge/config/README.en.md +44 -0
  12. package/knowledge/config/README.md +44 -0
  13. package/knowledge/config/role-composition.yaml +98 -0
  14. package/knowledge/config/role-extensions.yaml +140 -0
  15. package/knowledge/config/skill-compositions.yaml +142 -0
  16. package/knowledge/config/team-stage.yaml +95 -0
  17. package/knowledge/config/team-tasks.yaml +139 -0
  18. package/knowledge/config/team-triggers.yaml +198 -0
  19. package/knowledge/config/validation-patterns.yaml +137 -0
  20. package/knowledge/domain/README.md +115 -0
  21. package/knowledge/domain/flows/README.md +194 -0
  22. package/knowledge/domain/glossary.md +143 -0
  23. package/knowledge/domain/rules.md +138 -0
  24. package/knowledge/environment/README.en.md +36 -0
  25. package/knowledge/environment/README.md +87 -0
  26. package/knowledge/environment/component-knowledge.md +316 -0
  27. package/knowledge/environment/detection-patterns.yaml +502 -0
  28. package/knowledge/environment/middleware-knowledge.md +237 -0
  29. package/knowledge/environment/template-registry.md +321 -0
  30. package/knowledge/guides/domain-driven-design.md +345 -0
  31. package/knowledge/guides/knowledge-management.md +369 -0
  32. package/knowledge/guides/requirement-engineering.md +329 -0
  33. package/knowledge/guides/stages/ai-effect-evaluator.md +93 -0
  34. package/knowledge/guides/stages/code-implementer.md +205 -0
  35. package/knowledge/guides/stages/code-reviewer.md +111 -0
  36. package/knowledge/guides/stages/consistency-checker.md +177 -0
  37. package/knowledge/guides/stages/design-planner.md +401 -0
  38. package/knowledge/guides/stages/design-reviewer.md +83 -0
  39. package/knowledge/guides/stages/integration-test-runner.md +105 -0
  40. package/knowledge/guides/stages/release-checker.md +205 -0
  41. package/knowledge/guides/stages/requirement-analyzer.md +195 -0
  42. package/knowledge/guides/stages/requirement-reviewer.md +83 -0
  43. package/knowledge/guides/stages/security-reviewer.md +89 -0
  44. package/knowledge/guides/stages/test-context-analyzer.md +250 -0
  45. package/knowledge/guides/stages/test-generator.md +241 -0
  46. package/knowledge/guides/stages/test-planner.md +183 -0
  47. package/knowledge/guides/stages/test-reviewer.md +76 -0
  48. package/knowledge/guides/stages/unit-test-runner.md +83 -0
  49. package/knowledge/guides/support/ai-agent-analyzer.md +362 -0
  50. package/knowledge/guides/support/ai-anomaly-analyzer.md +213 -0
  51. package/knowledge/guides/support/ai-artifact-evaluator.md +192 -0
  52. package/knowledge/guides/support/ai-capability-analyzer.md +193 -0
  53. package/knowledge/guides/support/ai-component-analyzer.md +169 -0
  54. package/knowledge/guides/support/ai-data-validator.md +276 -0
  55. package/knowledge/guides/support/ai-evaluation-planner.md +374 -0
  56. package/knowledge/guides/support/ai-path-evaluator.md +274 -0
  57. package/knowledge/guides/support/ai-pipeline-evaluator.md +219 -0
  58. package/knowledge/guides/support/ai-rag-analyzer.md +339 -0
  59. package/knowledge/guides/support/ai-task-assessor.md +418 -0
  60. package/knowledge/guides/support/ai-test-diagnostics.md +133 -0
  61. package/knowledge/guides/support/complexity-assessor.md +268 -0
  62. package/knowledge/guides/support/component-discovery.md +183 -0
  63. package/knowledge/guides/support/environment-scanner.md +207 -0
  64. package/knowledge/guides/support/environment-validator.md +207 -0
  65. package/knowledge/guides/support/knowledge-generator.md +234 -0
  66. package/knowledge/guides/support/methodology-extractor.md +55 -0
  67. package/knowledge/guides/support/pipeline-protocol.md +438 -0
  68. package/knowledge/guides/support/practice-logger.md +359 -0
  69. package/knowledge/guides/support/scope-inference.md +174 -0
  70. package/knowledge/guides/support/skill-distiller.md +91 -0
  71. package/knowledge/guides/support/skill-updater.md +45 -0
  72. package/knowledge/guides/support/skill-validator.md +72 -0
  73. package/knowledge/guides/support/team-orchestrator.md +323 -0
  74. package/knowledge/guides/support/tech-stack-analyzer.md +139 -0
  75. package/knowledge/guides/support/test-runner.md +254 -0
  76. package/knowledge/guides/system-design.md +352 -0
  77. package/knowledge/organization/ai-native-team.md +318 -0
  78. package/knowledge/organization/team-metrics.md +228 -0
  79. package/knowledge/principles/constitution.md +134 -0
  80. package/knowledge/principles/core-principles.md +368 -0
  81. package/knowledge/principles/design-philosophy.md +877 -0
  82. package/knowledge/principles/evolution.md +553 -0
  83. package/knowledge/process/01-requirement.md +113 -0
  84. package/knowledge/process/02-design.md +123 -0
  85. package/knowledge/process/03-implementation.md +90 -0
  86. package/knowledge/process/04-review.md +80 -0
  87. package/knowledge/process/05-testing.md +90 -0
  88. package/knowledge/process/06-delivery.md +88 -0
  89. package/knowledge/process/README.en.md +38 -0
  90. package/knowledge/process/README.md +48 -0
  91. package/knowledge/process/ai-sdlc.md +475 -0
  92. package/knowledge/process/overview.md +319 -0
  93. package/knowledge/standards/code-review.md +876 -0
  94. package/knowledge/standards/coding-style.md +940 -0
  95. package/knowledge/standards/data-consistency.md +1085 -0
  96. package/knowledge/standards/document-versioning.md +210 -0
  97. package/knowledge/standards/risk-detection.md +186 -0
  98. package/knowledge/templates/ai-evaluation.md +150 -0
  99. package/knowledge/templates/api-design.md +117 -0
  100. package/knowledge/templates/database-design.md +132 -0
  101. package/knowledge/templates/domain-driven-design.md +321 -0
  102. package/knowledge/templates/product-proposal.md +201 -0
  103. package/knowledge/templates/system-design.md +227 -0
  104. package/knowledge/templates/task-breakdown.md +107 -0
  105. package/knowledge/templates/test-case.md +170 -0
  106. package/package.json +53 -0
  107. package/plugins/.claude-plugin/plugin.json +134 -0
  108. package/plugins/agents/roles/ai-engineer.md +129 -0
  109. package/plugins/agents/roles/backend-engineer.md +165 -0
  110. package/plugins/agents/roles/ceo.md +94 -0
  111. package/plugins/agents/roles/data-engineer.md +135 -0
  112. package/plugins/agents/roles/devops-engineer.md +181 -0
  113. package/plugins/agents/roles/frontend-engineer.md +129 -0
  114. package/plugins/agents/roles/product-owner.md +98 -0
  115. package/plugins/agents/roles/quality-engineer.md +129 -0
  116. package/plugins/agents/roles/security-engineer.md +180 -0
  117. package/plugins/agents/roles/tech-lead.md +97 -0
  118. package/plugins/agents/support/blind-comparator.md +88 -0
  119. package/plugins/agents/support/consistency-checker.md +103 -0
  120. package/plugins/agents/support/failure-diagnostician.md +141 -0
  121. package/plugins/agents/support/independent-reviewer.md +80 -0
  122. package/plugins/agents/support/safety-auditor.md +121 -0
  123. package/plugins/agents/support/skill-benchmarker.md +86 -0
  124. package/plugins/agents/support/skill-forger.md +105 -0
  125. package/plugins/agents/support/stage-gate-evaluator.md +121 -0
  126. package/plugins/agents/support/test-coverage-reviewer.md +73 -0
  127. package/plugins/benchmarks/templates/README.md +44 -0
  128. package/plugins/benchmarks/templates/commands/explore-template.yaml +48 -0
  129. package/plugins/benchmarks/templates/pipeline/agile-template.yaml +84 -0
  130. package/plugins/benchmarks/templates/pipeline/waterfall-template.yaml +106 -0
  131. package/plugins/benchmarks/templates/skills/requirement-analyzer-template.yaml +48 -0
  132. package/plugins/commands/README.en.md +96 -0
  133. package/plugins/commands/README.md +96 -0
  134. package/plugins/commands/apply.md +191 -0
  135. package/plugins/commands/archive.md +76 -0
  136. package/plugins/commands/env-export.md +79 -0
  137. package/plugins/commands/env-sync.md +640 -0
  138. package/plugins/commands/env-template.md +223 -0
  139. package/plugins/commands/env-update.md +264 -0
  140. package/plugins/commands/env-validate.md +176 -0
  141. package/plugins/commands/env.md +79 -0
  142. package/plugins/commands/explore.md +76 -0
  143. package/plugins/commands/field-evolve.md +536 -0
  144. package/plugins/commands/memory.md +249 -0
  145. package/plugins/commands/project-evolve.md +821 -0
  146. package/plugins/commands/propose.md +93 -0
  147. package/plugins/commands/review.md +140 -0
  148. package/plugins/commands/run.md +224 -0
  149. package/plugins/commands/status.md +62 -0
  150. package/plugins/commands/validate.md +108 -0
  151. package/plugins/hooks/README.en.md +56 -0
  152. package/plugins/hooks/README.md +56 -0
  153. package/plugins/hooks/ai-project-guard.js +329 -0
  154. package/plugins/hooks/artifact-evaluation-hook.js +237 -0
  155. package/plugins/hooks/constitution-guard.js +211 -0
  156. package/plugins/hooks/environment-autocommit.js +264 -0
  157. package/plugins/hooks/environment-manager.js +778 -0
  158. package/plugins/hooks/execution-tracker.js +354 -0
  159. package/plugins/hooks/frozen-zone-guard.js +140 -0
  160. package/plugins/hooks/layer1-validator.js +423 -0
  161. package/plugins/hooks/lib/artifact-evaluator.js +414 -0
  162. package/plugins/hooks/lib/benchmarks/change-detector.js +390 -0
  163. package/plugins/hooks/lib/benchmarks/evaluator.js +605 -0
  164. package/plugins/hooks/lib/benchmarks/integration-example.js +169 -0
  165. package/plugins/hooks/lib/data-and-ai-detector.js +275 -0
  166. package/plugins/hooks/lib/detection-pattern-loader.js +865 -0
  167. package/plugins/hooks/lib/directory-discovery.js +395 -0
  168. package/plugins/hooks/lib/environment-config-loader.js +341 -0
  169. package/plugins/hooks/lib/environment-detector.js +553 -0
  170. package/plugins/hooks/lib/environment-evolver.js +564 -0
  171. package/plugins/hooks/lib/environment-registry.js +813 -0
  172. package/plugins/hooks/lib/execution-path.js +427 -0
  173. package/plugins/hooks/lib/hook-error-recorder.js +245 -0
  174. package/plugins/hooks/lib/hook-logger.js +538 -0
  175. package/plugins/hooks/lib/hook-runner.js +97 -0
  176. package/plugins/hooks/lib/hook-runner.sh +44 -0
  177. package/plugins/hooks/lib/hook-state-manager.js +480 -0
  178. package/plugins/hooks/lib/memory-extractor.js +377 -0
  179. package/plugins/hooks/lib/memory-manager.js +673 -0
  180. package/plugins/hooks/lib/metrics-analyzer.js +489 -0
  181. package/plugins/hooks/lib/project-evolution/auto-fixer.js +511 -0
  182. package/plugins/hooks/lib/project-evolution/memory-manager.js +346 -0
  183. package/plugins/hooks/lib/project-evolution/pattern-detector.js +476 -0
  184. package/plugins/hooks/lib/project-evolution/semantic-indexer.js +480 -0
  185. package/plugins/hooks/lib/project-structure-detector.js +326 -0
  186. package/plugins/hooks/lib/rollback-tracker.js +346 -0
  187. package/plugins/hooks/lib/source-code-scanner.js +596 -0
  188. package/plugins/hooks/lib/technology-stack-detector.js +374 -0
  189. package/plugins/hooks/lib/test-failure-analyzer.js +375 -0
  190. package/plugins/hooks/lib/test-failure-fixer.js +268 -0
  191. package/plugins/hooks/lib/trace-context.js +277 -0
  192. package/plugins/hooks/lib/validation-patterns.js +415 -0
  193. package/plugins/hooks/memory-sync.js +171 -0
  194. package/plugins/hooks/pipeline-observer.js +413 -0
  195. package/plugins/hooks/scope-sentinel.js +204 -0
  196. package/plugins/hooks/trace-initialization.js +169 -0
  197. package/plugins/memory/templates/code-quality.yaml +149 -0
  198. package/plugins/memory/templates/multi-system.yaml +155 -0
  199. package/plugins/memory/templates/team-habits.yaml +119 -0
  200. package/plugins/memory/templates/testing.yaml +121 -0
  201. package/plugins/skills/README.en.md +47 -0
  202. package/plugins/skills/README.md +104 -0
  203. package/plugins/skills/benchmark-executor/README.md +93 -0
  204. package/plugins/skills/benchmark-executor/SKILL.md +647 -0
  205. package/plugins/skills/benchmark-generator/SKILL.md +349 -0
  206. package/plugins/skills/delivery-stage/SKILL.md +203 -0
  207. package/plugins/skills/design-stage/SKILL.md +216 -0
  208. package/plugins/skills/evolution-process/SKILL.md +291 -0
  209. package/plugins/skills/exploration-phase/SKILL.md +133 -0
  210. package/plugins/skills/implementation-stage/SKILL.md +179 -0
  211. package/plugins/skills/layer1-validation/SKILL.md +79 -0
  212. package/plugins/skills/pending-dashboard/SKILL.md +109 -0
  213. package/plugins/skills/project-evolution/SKILL.md +847 -0
  214. package/plugins/skills/requirement-stage/SKILL.md +183 -0
  215. package/plugins/skills/skill-forge/SKILL.md +223 -0
  216. package/plugins/skills/skill-forge/references/description-guide.md +92 -0
  217. package/plugins/skills/skill-forge/references/quality-rubric.md +104 -0
  218. package/plugins/skills/skill-forge/references/skill-template.md +106 -0
  219. package/plugins/skills/startup-guard/SKILL.md +38 -0
  220. package/plugins/skills/testing-stage/SKILL.md +195 -0
  221. package/scripts/cli/global-init.js +288 -0
  222. package/scripts/cli/global.js +324 -0
  223. package/scripts/cli/index.js +55 -0
  224. package/scripts/cli/init.js +382 -0
  225. package/scripts/cli/list.js +69 -0
  226. package/scripts/cli/org.js +340 -0
  227. package/scripts/cli/update.js +44 -0
  228. package/scripts/config/commands.config.js +145 -0
  229. package/scripts/config/hooks.config.js +197 -0
  230. package/scripts/evolution/evolution-router.js +273 -0
  231. package/scripts/evolution/evolution-signal-collector.js +307 -0
  232. package/scripts/evolution/knowledge-loader.js +346 -0
  233. package/scripts/evolution/marketplace.js +317 -0
  234. package/scripts/evolution/version-manager.js +371 -0
  235. package/scripts/install/agents.js +106 -0
  236. package/scripts/install/commands.js +133 -0
  237. package/scripts/install/constants.js +424 -0
  238. package/scripts/install/hook-logger.js +536 -0
  239. package/scripts/install/hooks.js +110 -0
  240. package/scripts/install/index.js +39 -0
  241. package/scripts/install/skills.js +95 -0
  242. package/scripts/postinstall.js +25 -0
  243. package/scripts/state.js +376 -0
@@ -0,0 +1,198 @@
1
+ # 团队角色触发配置
2
+ # 定义复杂度阈值、强制触发规则、阶段-角色映射
3
+
4
+ # ============================================
5
+ # 复杂度阈值
6
+ # ============================================
7
+ complexity_threshold:
8
+ simple: 5 # <=5 简单任务,快速通道
9
+ medium: 8 # 6-8 中等任务,引入核心角色
10
+ complex: 9 # >=9 复杂任务,引入完整团队
11
+
12
+ # ============================================
13
+ # 强制触发规则(不受复杂度影响)
14
+ # ============================================
15
+ force_triggers:
16
+ # 安全相关
17
+ - id: user_data
18
+ condition: "涉及用户数据存储或处理"
19
+ keywords: ["用户数据", "个人信息", "用户信息", "隐私数据", "用户资料"]
20
+ roles: ["security-engineer"]
21
+
22
+ - id: payment
23
+ condition: "涉及支付或资金交易功能"
24
+ keywords: ["支付", "付款", "充值", "提现", "转账", "资金交易", "订单支付"]
25
+ roles: ["security-engineer"]
26
+
27
+ - id: external_api
28
+ condition: "涉及外部API调用"
29
+ keywords: ["外部API", "第三方接口", "开放平台", "外部服务", "回调接口"]
30
+ roles: ["security-engineer"]
31
+
32
+ # 架构相关
33
+ - id: new_architecture
34
+ condition: "涉及新架构或框架引入"
35
+ keywords: ["新架构", "架构调整", "架构重构", "新框架", "技术栈升级", "框架迁移"]
36
+ roles: ["tech-lead"]
37
+
38
+ - id: cross_system
39
+ condition: "涉及跨系统变更"
40
+ keywords: ["跨系统", "多系统", "系统集成", "系统对接", "微服务"]
41
+ roles: ["tech-lead", "devops-engineer"]
42
+
43
+ # 部署相关
44
+ - id: new_service
45
+ condition: "涉及新服务部署"
46
+ keywords: ["新服务", "服务部署", "新模块部署", "独立服务"]
47
+ roles: ["devops-engineer"]
48
+
49
+ - id: db_change
50
+ condition: "涉及数据库变更"
51
+ keywords: ["数据库变更", "表结构", "数据迁移", "数据库升级"]
52
+ roles: ["devops-engineer"]
53
+
54
+ - id: infrastructure
55
+ condition: "涉及基础设施变更"
56
+ keywords: ["基础设施", "服务器", "容器", "K8s", "云资源", "网络配置"]
57
+ roles: ["devops-engineer"]
58
+
59
+ # ============================================
60
+ # 阶段-角色映射
61
+ # ============================================
62
+ stage_role_mapping:
63
+
64
+ # 需求阶段
65
+ requirement:
66
+ simple:
67
+ - ceo
68
+ - product-owner
69
+ medium:
70
+ - ceo
71
+ - product-owner
72
+ - tech-lead
73
+ complex:
74
+ - ceo
75
+ - product-owner
76
+ - tech-lead
77
+ - backend-engineer
78
+ - frontend-engineer
79
+ - quality-engineer
80
+ # 条件触发
81
+ conditional:
82
+ - roles: ["security-engineer"]
83
+ condition: "dataSensitivity >= 2"
84
+ - roles: ["ai-engineer"]
85
+ condition: "hasAISubsystem"
86
+ - roles: ["data-engineer"]
87
+ condition: "hasDataSubsystem"
88
+
89
+ # 设计阶段
90
+ design:
91
+ simple:
92
+ - tech-lead
93
+ medium:
94
+ - tech-lead
95
+ - backend-engineer
96
+ - frontend-engineer
97
+ complex:
98
+ - tech-lead
99
+ - backend-engineer
100
+ - frontend-engineer
101
+ - data-engineer
102
+ - ai-engineer
103
+ - quality-engineer
104
+ conditional:
105
+ - roles: ["security-engineer"]
106
+ condition: "dataSensitivity >= 2"
107
+ - roles: ["devops-engineer"]
108
+ condition: "deploymentRisk >= 2"
109
+ - roles: ["devops-engineer"]
110
+ condition: "hasArchitectureChange"
111
+
112
+ # 编码阶段
113
+ code:
114
+ simple:
115
+ - tech-lead
116
+ medium:
117
+ - tech-lead
118
+ - relevant-engineer
119
+ complex:
120
+ - tech-lead
121
+ - backend-engineer
122
+ - frontend-engineer
123
+ - data-engineer
124
+ - ai-engineer
125
+ conditional:
126
+ - roles: ["security-engineer"]
127
+ condition: "dataSensitivity >= 3"
128
+
129
+ # 测试阶段
130
+ test:
131
+ simple:
132
+ - quality-engineer
133
+ medium:
134
+ - quality-engineer
135
+ - tech-lead
136
+ complex:
137
+ - quality-engineer
138
+ - tech-lead
139
+ - backend-engineer
140
+ - frontend-engineer
141
+ conditional:
142
+ - roles: ["security-engineer"]
143
+ condition: "dataSensitivity >= 3"
144
+
145
+ # 交付阶段
146
+ delivery:
147
+ simple:
148
+ - quality-engineer
149
+ - tech-lead
150
+ medium:
151
+ - quality-engineer
152
+ - tech-lead
153
+ complex:
154
+ - quality-engineer
155
+ - tech-lead
156
+ - devops-engineer
157
+ conditional:
158
+ - roles: ["security-engineer"]
159
+ condition: "dataSensitivity >= 2"
160
+ - roles: ["devops-engineer"]
161
+ condition: "hasDeploymentRisk"
162
+
163
+ # ============================================
164
+ # 子系统类型-工程师映射
165
+ # ============================================
166
+ subsystem_engineer_mapping:
167
+ backend: backend-engineer
168
+ frontend: frontend-engineer
169
+ web: frontend-engineer
170
+ mobile: frontend-engineer
171
+ data: data-engineer
172
+ ai: ai-engineer
173
+ ml: ai-engineer
174
+ model: ai-engineer
175
+
176
+ # ============================================
177
+ # 复杂度维度权重(用于微调)
178
+ # ============================================
179
+ dimension_weights:
180
+ requirement: 1.0 # 需求复杂度
181
+ technical: 1.0 # 技术复杂度
182
+ data_sensitivity: 1.0 # 数据敏感度
183
+ business: 1.0 # 业务复杂度
184
+
185
+ # ============================================
186
+ # 快速通道规则
187
+ # ============================================
188
+ fast_track:
189
+ enabled: true
190
+ max_score: 5
191
+ # 快速通道跳过的检查
192
+ skip_checks:
193
+ - expert_review # 跳过专家审查
194
+ - full_team_review # 跳过完整团队审查
195
+ # 快速通道仍需执行的检查
196
+ required_checks:
197
+ - layer1_validation
198
+ - basic_review
@@ -0,0 +1,137 @@
1
+ # AutoSpec 验证命令模式配置
2
+ # 用于 Layer 1 验证的命令检测
3
+
4
+ # ============================================================
5
+ # Layer 1 验证命令模式
6
+ # ============================================================
7
+ validationCommands:
8
+ test:
9
+ pattern: "\\b(npm test|npm run test|jest|mocha|pytest|go test|cargo test|vitest|ava|tap|bun test)\\b"
10
+ description: 测试命令
11
+
12
+ build:
13
+ pattern: "\\b(npm run build|cargo build|go build|make|gradle|mvn|tsc|bun build)\\b"
14
+ description: 构建命令
15
+
16
+ lint:
17
+ pattern: "\\b(eslint|tslint|standard|xo|biome|eslint-cli)\\b"
18
+ description: Lint 检查命令
19
+
20
+ typecheck:
21
+ pattern: "\\b(npx tsc|tsc --noEmit|flow|mypy|pyright|pyre)\\b"
22
+ description: 类型检查命令
23
+
24
+ format:
25
+ pattern: "\\b(prettier|black|gofmt|rustfmt|clang-format)\\b"
26
+ description: 格式化命令
27
+
28
+ security:
29
+ pattern: "\\b(npm audit|yarn audit|snyk|safety|pip-audit|trivy)\\b"
30
+ description: 安全检查命令
31
+
32
+ # ============================================================
33
+ # 冻结区文件模式
34
+ # ============================================================
35
+ frozenPatterns:
36
+ - pattern: "constitution\\.md$"
37
+ description: 宪法文件
38
+
39
+ - pattern: "evolution\\.md$"
40
+ description: 进化机制文件
41
+
42
+ - pattern: "design-philosophy\\.md$"
43
+ description: 设计哲学文件
44
+
45
+ - pattern: "pipeline/overview\\.md$"
46
+ description: 流程概览文件
47
+
48
+ # ============================================================
49
+ # 开发文件模式
50
+ # ============================================================
51
+ developmentPatterns:
52
+ - pattern: "\\.(js|ts|jsx|tsx|py|java|go|rs|cpp|c|h|php|rb|swift|kt|scala|vue|svelte)\\b"
53
+ description: 源代码文件
54
+
55
+ - pattern: "package\\.json$"
56
+ description: NPM 配置
57
+
58
+ - pattern: "pom\\.xml$"
59
+ description: Maven 配置
60
+
61
+ - pattern: "build\\.gradle"
62
+ description: Gradle 配置
63
+
64
+ - pattern: "Cargo\\.toml$"
65
+ description: Cargo 配置
66
+
67
+ - pattern: "go\\.mod$"
68
+ description: Go 模块配置
69
+
70
+ - pattern: "pyproject\\.toml$"
71
+ description: Python 项目配置
72
+
73
+ # ============================================================
74
+ # 配置文件模式
75
+ # ============================================================
76
+ configFilePatterns:
77
+ - pattern: "package\\.json$"
78
+ description: NPM 配置
79
+
80
+ - pattern: "tsconfig.*\\.json$"
81
+ description: TypeScript 配置
82
+
83
+ - pattern: "\\.eslintrc"
84
+ description: ESLint 配置
85
+
86
+ - pattern: "(webpack|vite|rollup).*config"
87
+ description: 打包工具配置
88
+
89
+ - pattern: "docker"
90
+ description: Docker 相关
91
+
92
+ - pattern: "\\.env"
93
+ description: 环境变量文件
94
+
95
+ # ============================================================
96
+ # 敏感信息检测模式
97
+ # ============================================================
98
+ sensitivePatterns:
99
+ - pattern: "password\\s*[:=]\\s*['\"][^'\"]+['\"]"
100
+ description: 密码
101
+
102
+ - pattern: "secret\\s*[:=]\\s*['\"][^'\"]+['\"]"
103
+ description: 密钥
104
+
105
+ - pattern: "api[_-]?key\\s*[:=]\\s*['\"][^'\"]+['\"]"
106
+ description: API Key
107
+
108
+ - pattern: "token\\s*[:=]\\s*['\"][^'\"]+['\"]"
109
+ description: Token
110
+
111
+ - pattern: "private[_-]?key\\s*[:=]\\s*['\"][^'\"]+['\"]"
112
+ description: 私钥
113
+
114
+ # ============================================================
115
+ # 危险命令模式
116
+ # ============================================================
117
+ dangerousPatterns:
118
+ - pattern: "rm\\s+-rf"
119
+ description: 强制删除
120
+
121
+ - pattern: "sudo\\s+"
122
+ description: 提权命令
123
+
124
+ - pattern: "mkfs"
125
+ description: 格式化磁盘
126
+
127
+ - pattern: "dd\\s+if="
128
+ description: 磁盘操作
129
+
130
+ - pattern: ">\\s*/dev/"
131
+ description: 设备写入
132
+
133
+ - pattern: "curl.*\\|.*sh"
134
+ description: 远程脚本执行
135
+
136
+ - pattern: "wget.*\\|.*sh"
137
+ description: 远程脚本执行
@@ -0,0 +1,115 @@
1
+ # 业务知识沉淀体系
2
+
3
+ > 定位:将项目特有的业务知识结构化沉淀,作为上下文注入各阶段。
4
+
5
+ ## 目录结构
6
+
7
+ ```
8
+ knowledge/domain/
9
+ ├── README.md # 本文件:使用指南
10
+ ├── glossary.md # 术语表:统一业务概念定义
11
+ ├── rules.md # 业务规则:规则ID化,便于追溯
12
+ └── flows/ # 业务流程图:Mermaid格式,可视化业务逻辑
13
+ └── README.md # 流程图规范
14
+ ```
15
+
16
+ ## 使用方式
17
+
18
+ ### 阶段注入
19
+
20
+ | 阶段 | 注入内容 | 用途 |
21
+ |------|---------|------|
22
+ | 需求分析 | glossary + rules | 理解业务背景,避免歧义 |
23
+ | 方案设计 | glossary + flows | 设计符合业务逻辑的技术方案 |
24
+ | 代码审查 | rules | 检验代码是否遵循业务规则 |
25
+ | 测试验证 | rules + flows | 构造测试场景,覆盖业务流程 |
26
+
27
+ ### 与环境知识的关系
28
+
29
+ | 知识类型 | 处理层面 | 示例 |
30
+ |---------|---------|------|
31
+ | **环境知识** | 技术层 | 中间件配置、组件库、CI/CD |
32
+ | **业务知识** | 业务层 | 术语定义、业务规则、流程图 |
33
+
34
+ 两者互补,共同构成立体上下文。
35
+
36
+ ### 与项目产出物的关系
37
+
38
+ 业务知识是**项目无关的通用知识**,产出物中的业务规则应引用此处定义:
39
+
40
+ ```
41
+ 产出物 requirement.md 中的业务规则
42
+ ↓ 引用
43
+ knowledge/domain/rules.md 中的 BR-ID
44
+ ```
45
+
46
+ ## 进化分区
47
+
48
+ | 内容 | 进化分区 | 变更方式 |
49
+ |------|---------|---------|
50
+ | glossary.md | 自由区 | 从需求文档自动提取 + 人工确认 |
51
+ | rules.md | 受控区 | 从 practice-log 提取 + 人工审批 |
52
+ | flows/ | 自由区 | 从设计文档提取 + validator 验证 |
53
+
54
+ ## 脱敏原则
55
+
56
+ 业务知识沉淀遵循以下脱敏原则:
57
+
58
+ - ❌ 不记录具体客户信息
59
+ - ❌ 不记录敏感金额数据
60
+ - ❌ 不使用公司/产品特有名称
61
+ - ✅ 使用通用化示例:用"支付"替代特指渠道
62
+ - ✅ 使用占位符:`user_001`、`order_123`
63
+
64
+ ## 快速开始
65
+
66
+ ### 1. 初始化术语表
67
+
68
+ ```bash
69
+ # 从需求文档提取候选术语
70
+ # 高频词、首字母缩写、专用名词
71
+ ```
72
+
73
+ ### 2. 定义业务规则
74
+
75
+ ```markdown
76
+ # 在 rules.md 中添加
77
+ | 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 |
78
+ |--------|---------|---------|---------|---------|
79
+ | BR-01 | (规则名) | (描述) | (场景) | (方式) |
80
+ ```
81
+
82
+ ### 3. 绘制业务流程
83
+
84
+ ```markdown
85
+ # 在 flows/ 中创建
86
+ # 使用 Mermaid flowchart 格式
87
+ ```
88
+
89
+ ## 维护指南
90
+
91
+ ### 术语冲突处理
92
+
93
+ 当术语定义冲突时:
94
+ 1. 以 `glossary.md` 为准
95
+ 2. 如有歧义,在需求分析阶段澄清
96
+ 3. 澄清后更新 `glossary.md`
97
+
98
+ ### 规则变更流程
99
+
100
+ 1. 识别规则变更需求(来自需求/缺陷/反馈)
101
+ 2. 在 `rules.md` 中更新规则
102
+ 3. 标注变更版本和原因
103
+ 4. 通知相关阶段(设计/测试/审查)
104
+
105
+ ### 流程图更新
106
+
107
+ 1. 业务流程变更时同步更新
108
+ 2. 保持与设计文档的一致性
109
+ 3. 版本化记录变更历史
110
+
111
+ ---
112
+
113
+ **维护者**: 项目团队
114
+ **进化分区**: 自由区/受控区
115
+ **关联文档**: `knowledge/environment/README.md`
@@ -0,0 +1,194 @@
1
+ # 业务流程图规范
2
+
3
+ > 使用 Mermaid 格式可视化业务流程。
4
+
5
+ ## 流程图规范
6
+
7
+ ### 命名规范
8
+
9
+ - 文件名:`{流程名}-flow.md`
10
+ - 示例:`order-creation-flow.md`、`user-registration-flow.md`
11
+
12
+ ### 格式规范
13
+
14
+ 每个流程图文件包含以下内容:
15
+
16
+ ```markdown
17
+ # [流程名称]流程
18
+
19
+ ## 流程描述
20
+ (简要说明流程目的和触发条件)
21
+
22
+ ## 流程图
23
+
24
+ ​```mermaid
25
+ flowchart TD
26
+ A[开始] --> B{条件判断}
27
+ B -->|是| C[动作1]
28
+ B -->|否| D[动作2]
29
+ C --> E[结束]
30
+ D --> E
31
+ ​```
32
+
33
+ ## 异常处理
34
+ (描述异常分支处理方式)
35
+
36
+ ## 相关规则
37
+ - BR-XX: 相关业务规则
38
+
39
+ ## 版本历史
40
+ | 版本 | 日期 | 修改人 | 修改说明 |
41
+ |-----|------|--------|---------|
42
+ | v1.0 | YYYY-MM-DD | | 初始版本 |
43
+ ```
44
+
45
+ ## Mermaid 语法参考
46
+
47
+ ### 基本元素
48
+
49
+ ```mermaid
50
+ flowchart TD
51
+ A[矩形节点] --> B{菱形判断}
52
+ B -->|是| C((圆形节点))
53
+ B -->|否| D[[子程序]]
54
+ C --> E>不对称节点]
55
+ ```
56
+
57
+ ### 连线类型
58
+
59
+ | 语法 | 效果 |
60
+ |------|------|
61
+ | `-->` | 实线箭头 |
62
+ | `---` | 实线无箭头 |
63
+ | `-.->` | 虚线箭头 |
64
+ | `==>` | 粗线箭头 |
65
+
66
+ ### 子图分组
67
+
68
+ ```mermaid
69
+ flowchart TD
70
+ subgraph 模块A
71
+ A1[步骤1] --> A2[步骤2]
72
+ end
73
+ subgraph 模块B
74
+ B1[步骤3] --> B2[步骤4]
75
+ end
76
+ A2 --> B1
77
+ ```
78
+
79
+ ### 样式标记
80
+
81
+ ```mermaid
82
+ flowchart TD
83
+ A[正常节点] --> B{判断节点}
84
+ B -->|成功| C[成功节点]
85
+ B -->|失败| D[失败节点]
86
+
87
+ %% 样式定义
88
+ style C fill:#90EE90
89
+ style D fill:#FFB6C1
90
+ ```
91
+
92
+ ## 流程类型
93
+
94
+ ### 业务主流程
95
+
96
+ 描述核心业务流程,如:下单流程、支付流程...
97
+
98
+ **特点**:
99
+ - 覆盖完整业务链路
100
+ - 包含所有关键分支
101
+ - 标注关键业务规则
102
+
103
+ ### 异常处理流程
104
+
105
+ 描述异常场景处理,如:超时重试、失败回滚...
106
+
107
+ **特点**:
108
+ - 明确异常触发条件
109
+ - 描述异常处理步骤
110
+ - 标注恢复机制
111
+
112
+ ### 状态流转图
113
+
114
+ 描述对象状态变化,如:订单状态、任务状态...
115
+
116
+ **特点**:
117
+ - 使用状态机图(stateDiagram)
118
+ - 标注状态转换条件
119
+ - 明确初始和终止状态
120
+
121
+ ## 与设计阶段的关系
122
+
123
+ | 阶段 | 使用方式 |
124
+ |------|---------|
125
+ | 需求分析 | 产出业务流程图,描述业务逻辑 |
126
+ | 方案设计 | 产出时序图,需与业务流程图对应 |
127
+ | 测试验证 | 基于流程图设计测试场景 |
128
+
129
+ ## 流程图质量检查
130
+
131
+ ### 完整性检查
132
+
133
+ - [ ] 有明确的开始和结束节点
134
+ - [ ] 覆盖所有业务场景(正常+异常)
135
+ - [ ] 每个判断节点有明确的分支条件
136
+ - [ ] 异常处理路径完整
137
+
138
+ ### 一致性检查
139
+
140
+ - [ ] 术语与 glossary.md 一致
141
+ - [ ] 规则引用与 rules.md 一致
142
+ - [ ] 与设计文档的时序图对应
143
+
144
+ ### 可读性检查
145
+
146
+ - [ ] 节点命名清晰
147
+ - [ ] 分支条件明确
148
+ - [ ] 层次结构合理
149
+ - [ ] 样式标记恰当
150
+
151
+ ## 示例
152
+
153
+ ### 示例:订单创建流程
154
+
155
+ ```markdown
156
+ # 订单创建流程
157
+
158
+ ## 流程描述
159
+ 用户提交订单,系统校验后创建订单并支付。
160
+
161
+ ## 流程图
162
+
163
+ ​```mermaid
164
+ flowchart TD
165
+ A[用户提交订单] --> B{库存校验}
166
+ B -->|充足| C{价格校验}
167
+ B -->|不足| D[返回库存不足]
168
+ C -->|有效| E[创建订单]
169
+ C -->|无效| F[返回价格异常]
170
+ E --> G{支付处理}
171
+ G -->|成功| H[订单完成]
172
+ G -->|失败| I[订单取消]
173
+ I --> J[释放库存]
174
+
175
+ style D fill:#FFB6C1
176
+ style F fill:#FFB6C1
177
+ style H fill:#90EE90
178
+ ​```
179
+
180
+ ## 异常处理
181
+ - 库存不足:返回错误,提示用户调整数量
182
+ - 价格异常:返回错误,提示用户刷新重试
183
+ - 支付失败:取消订单,释放库存
184
+
185
+ ## 相关规则
186
+ - BR-01: 库存必须充足才能创建订单
187
+ - BR-02: 订单创建后30分钟内需完成支付
188
+ ```
189
+
190
+ ---
191
+
192
+ **维护者**: 项目团队
193
+ **进化分区**: 自由区
194
+ **关联文档**: `knowledge/domain/glossary.md`, `knowledge/domain/rules.md`