@chenmk/superflow 0.1.0

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 (198) hide show
  1. package/INSTALL.en.md +106 -0
  2. package/INSTALL.md +664 -0
  3. package/LICENSE +21 -0
  4. package/README.md +142 -0
  5. package/README.zh-CN.md +117 -0
  6. package/assets/context-templates/business-rules.md +98 -0
  7. package/assets/context-templates/decisions.md +153 -0
  8. package/assets/context-templates/external-systems.md +166 -0
  9. package/assets/context-templates/incidents.md +89 -0
  10. package/assets/manifest.json +53 -0
  11. package/assets/prompts/superflow-archive.md +9 -0
  12. package/assets/prompts/superflow-clarify.md +10 -0
  13. package/assets/prompts/superflow-design.md +10 -0
  14. package/assets/prompts/superflow-docs.md +10 -0
  15. package/assets/prompts/superflow-implement.md +10 -0
  16. package/assets/prompts/superflow-pipeline.md +13 -0
  17. package/assets/prompts/superflow-verify.md +10 -0
  18. package/assets/rules/superflow-phase-guard.md +50 -0
  19. package/assets/scripts/claude-auto-backup-hook.sh +313 -0
  20. package/assets/scripts/codex-auto-backup-hook.sh +361 -0
  21. package/assets/scripts/install-sql-pre-commit.sh +44 -0
  22. package/assets/scripts/superflow-contract-hooks.sh +744 -0
  23. package/assets/scripts/superflow-delivery-check.sh +315 -0
  24. package/assets/scripts/superflow-dependency-update-hook.sh +161 -0
  25. package/assets/scripts/superflow-enforce-hook.sh +70 -0
  26. package/assets/scripts/superflow-hook-guard.sh +132 -0
  27. package/assets/scripts/superflow-integration-evidence-hook.sh +80 -0
  28. package/assets/scripts/superflow-sql-sync-hook.py +950 -0
  29. package/assets/scripts/superflow-test-report-lint.py +433 -0
  30. package/assets/scripts/superflow-verify-integration.sh +90 -0
  31. package/assets/scripts/sync-settings-json.py +52 -0
  32. package/assets/skills/api-doc-changelog/SKILL.md +193 -0
  33. package/assets/skills/openspec-apply-change/SKILL.md +156 -0
  34. package/assets/skills/openspec-archive-change/SKILL.md +114 -0
  35. package/assets/skills/openspec-explore/SKILL.md +288 -0
  36. package/assets/skills/openspec-propose/SKILL.md +110 -0
  37. package/assets/skills/superflow-archive/SKILL.md +61 -0
  38. package/assets/skills/superflow-clarify/SKILL.md +146 -0
  39. package/assets/skills/superflow-clarify/agents/openai.yaml +4 -0
  40. package/assets/skills/superflow-design/SKILL.md +83 -0
  41. package/assets/skills/superflow-design/agents/openai.yaml +4 -0
  42. package/assets/skills/superflow-docs/SKILL.md +316 -0
  43. package/assets/skills/superflow-docs/agents/openai.yaml +4 -0
  44. package/assets/skills/superflow-hotfix/SKILL.md +48 -0
  45. package/assets/skills/superflow-implement/SKILL.md +461 -0
  46. package/assets/skills/superflow-implement/agents/openai.yaml +4 -0
  47. package/assets/skills/superflow-pipeline/SKILL.md +844 -0
  48. package/assets/skills/superflow-pipeline/agents/openai.yaml +4 -0
  49. package/assets/skills/superflow-pipeline/references/api-design-template.md +431 -0
  50. package/assets/skills/superflow-pipeline/references/architecture-design-template.md +119 -0
  51. package/assets/skills/superflow-pipeline/references/batch-prompt-template.md +536 -0
  52. package/assets/skills/superflow-pipeline/references/batch-split-guide.md +140 -0
  53. package/assets/skills/superflow-pipeline/references/decision-point.md +30 -0
  54. package/assets/skills/superflow-pipeline/references/dirty-worktree.md +35 -0
  55. package/assets/skills/superflow-pipeline/references/document-templates.md +123 -0
  56. package/assets/skills/superflow-pipeline/references/feature-gated-workflow.md +124 -0
  57. package/assets/skills/superflow-pipeline/references/implementation-prompt-template.md +1056 -0
  58. package/assets/skills/superflow-pipeline/references/mock-strategy-guide.md +86 -0
  59. package/assets/skills/superflow-pipeline/references/openspec-format.md +57 -0
  60. package/assets/skills/superflow-pipeline/references/orchestration.md +639 -0
  61. package/assets/skills/superflow-pipeline/references/p0-baseline-template.md +174 -0
  62. package/assets/skills/superflow-pipeline/references/project-config.md +40 -0
  63. package/assets/skills/superflow-pipeline/references/prompt-usage-template.md +152 -0
  64. package/assets/skills/superflow-pipeline/references/quality-gate.md +299 -0
  65. package/assets/skills/superflow-pipeline/references/quality-standards.md +190 -0
  66. package/assets/skills/superflow-pipeline/references/reviewer-checklist.md +154 -0
  67. package/assets/skills/superflow-pipeline/references/sql-risk-review-checklist.md +323 -0
  68. package/assets/skills/superflow-pipeline/references/subagent-progress.md +90 -0
  69. package/assets/skills/superflow-pipeline/references/superpower-technical-design-template.md +125 -0
  70. package/assets/skills/superflow-pipeline/references/test-execution-template.md +220 -0
  71. package/assets/skills/superflow-pipeline/references/test-guide.md +30 -0
  72. package/assets/skills/superflow-pipeline/references/traceability-matrix.md +106 -0
  73. package/assets/skills/superflow-pipeline/references/validation-integrity.md +134 -0
  74. package/assets/skills/superflow-pipeline/scripts/superflow-archive.sh +178 -0
  75. package/assets/skills/superflow-pipeline/scripts/superflow-env.sh +118 -0
  76. package/assets/skills/superflow-pipeline/scripts/superflow-guard.sh +428 -0
  77. package/assets/skills/superflow-pipeline/scripts/superflow-handoff.sh +296 -0
  78. package/assets/skills/superflow-pipeline/scripts/superflow-state.sh +574 -0
  79. package/assets/skills/superflow-pipeline/scripts/superflow-status.sh +172 -0
  80. package/assets/skills/superflow-pipeline/scripts/superflow-yaml-validate.sh +138 -0
  81. package/assets/skills/superflow-table-impact-analysis/SKILL.md +77 -0
  82. package/assets/skills/superflow-tweak/SKILL.md +46 -0
  83. package/assets/skills/superflow-verify/SKILL.md +112 -0
  84. package/assets/skills-en/api-doc-changelog/SKILL.md +193 -0
  85. package/assets/skills-en/openspec-apply-change/SKILL.md +156 -0
  86. package/assets/skills-en/openspec-archive-change/SKILL.md +114 -0
  87. package/assets/skills-en/openspec-explore/SKILL.md +288 -0
  88. package/assets/skills-en/openspec-propose/SKILL.md +110 -0
  89. package/assets/skills-en/superflow-archive/SKILL.md +61 -0
  90. package/assets/skills-en/superflow-clarify/SKILL.md +146 -0
  91. package/assets/skills-en/superflow-clarify/agents/openai.yaml +4 -0
  92. package/assets/skills-en/superflow-design/SKILL.md +83 -0
  93. package/assets/skills-en/superflow-design/agents/openai.yaml +4 -0
  94. package/assets/skills-en/superflow-docs/SKILL.md +316 -0
  95. package/assets/skills-en/superflow-docs/agents/openai.yaml +4 -0
  96. package/assets/skills-en/superflow-hotfix/SKILL.md +48 -0
  97. package/assets/skills-en/superflow-implement/SKILL.md +461 -0
  98. package/assets/skills-en/superflow-implement/agents/openai.yaml +4 -0
  99. package/assets/skills-en/superflow-pipeline/SKILL.md +844 -0
  100. package/assets/skills-en/superflow-pipeline/agents/openai.yaml +4 -0
  101. package/assets/skills-en/superflow-pipeline/references/api-design-template.md +431 -0
  102. package/assets/skills-en/superflow-pipeline/references/architecture-design-template.md +119 -0
  103. package/assets/skills-en/superflow-pipeline/references/batch-prompt-template.md +536 -0
  104. package/assets/skills-en/superflow-pipeline/references/batch-split-guide.md +140 -0
  105. package/assets/skills-en/superflow-pipeline/references/decision-point.md +30 -0
  106. package/assets/skills-en/superflow-pipeline/references/dirty-worktree.md +35 -0
  107. package/assets/skills-en/superflow-pipeline/references/document-templates.md +123 -0
  108. package/assets/skills-en/superflow-pipeline/references/feature-gated-workflow.md +124 -0
  109. package/assets/skills-en/superflow-pipeline/references/implementation-prompt-template.md +1056 -0
  110. package/assets/skills-en/superflow-pipeline/references/mock-strategy-guide.md +86 -0
  111. package/assets/skills-en/superflow-pipeline/references/openspec-format.md +57 -0
  112. package/assets/skills-en/superflow-pipeline/references/orchestration.md +639 -0
  113. package/assets/skills-en/superflow-pipeline/references/p0-baseline-template.md +174 -0
  114. package/assets/skills-en/superflow-pipeline/references/project-config.md +40 -0
  115. package/assets/skills-en/superflow-pipeline/references/prompt-usage-template.md +152 -0
  116. package/assets/skills-en/superflow-pipeline/references/quality-gate.md +299 -0
  117. package/assets/skills-en/superflow-pipeline/references/quality-standards.md +190 -0
  118. package/assets/skills-en/superflow-pipeline/references/reviewer-checklist.md +154 -0
  119. package/assets/skills-en/superflow-pipeline/references/sql-risk-review-checklist.md +323 -0
  120. package/assets/skills-en/superflow-pipeline/references/subagent-progress.md +90 -0
  121. package/assets/skills-en/superflow-pipeline/references/superpower-technical-design-template.md +125 -0
  122. package/assets/skills-en/superflow-pipeline/references/test-execution-template.md +220 -0
  123. package/assets/skills-en/superflow-pipeline/references/test-guide.md +30 -0
  124. package/assets/skills-en/superflow-pipeline/references/traceability-matrix.md +106 -0
  125. package/assets/skills-en/superflow-pipeline/references/validation-integrity.md +134 -0
  126. package/assets/skills-en/superflow-pipeline/scripts/superflow-archive.sh +178 -0
  127. package/assets/skills-en/superflow-pipeline/scripts/superflow-env.sh +118 -0
  128. package/assets/skills-en/superflow-pipeline/scripts/superflow-guard.sh +428 -0
  129. package/assets/skills-en/superflow-pipeline/scripts/superflow-handoff.sh +296 -0
  130. package/assets/skills-en/superflow-pipeline/scripts/superflow-state.sh +574 -0
  131. package/assets/skills-en/superflow-pipeline/scripts/superflow-status.sh +172 -0
  132. package/assets/skills-en/superflow-pipeline/scripts/superflow-yaml-validate.sh +138 -0
  133. package/assets/skills-en/superflow-table-impact-analysis/SKILL.md +77 -0
  134. package/assets/skills-en/superflow-tweak/SKILL.md +46 -0
  135. package/assets/skills-en/superflow-verify/SKILL.md +112 -0
  136. package/dist/cli/index.js +186 -0
  137. package/dist/cli/index.js.map +1 -0
  138. package/dist/commands/archive.js +6 -0
  139. package/dist/commands/archive.js.map +1 -0
  140. package/dist/commands/clarify.js +6 -0
  141. package/dist/commands/clarify.js.map +1 -0
  142. package/dist/commands/design.js +6 -0
  143. package/dist/commands/design.js.map +1 -0
  144. package/dist/commands/docs.js +6 -0
  145. package/dist/commands/docs.js.map +1 -0
  146. package/dist/commands/doctor.js +473 -0
  147. package/dist/commands/doctor.js.map +1 -0
  148. package/dist/commands/implement.js +6 -0
  149. package/dist/commands/implement.js.map +1 -0
  150. package/dist/commands/init.js +471 -0
  151. package/dist/commands/init.js.map +1 -0
  152. package/dist/commands/pipeline.js +6 -0
  153. package/dist/commands/pipeline.js.map +1 -0
  154. package/dist/commands/scan.js +59 -0
  155. package/dist/commands/scan.js.map +1 -0
  156. package/dist/commands/status.js +173 -0
  157. package/dist/commands/status.js.map +1 -0
  158. package/dist/commands/uninstall.js +213 -0
  159. package/dist/commands/uninstall.js.map +1 -0
  160. package/dist/commands/update.js +187 -0
  161. package/dist/commands/update.js.map +1 -0
  162. package/dist/commands/verify.js +6 -0
  163. package/dist/commands/verify.js.map +1 -0
  164. package/dist/core/assets.js +27 -0
  165. package/dist/core/assets.js.map +1 -0
  166. package/dist/core/context.js +100 -0
  167. package/dist/core/context.js.map +1 -0
  168. package/dist/core/dependencies.js +146 -0
  169. package/dist/core/dependencies.js.map +1 -0
  170. package/dist/core/detect.js +71 -0
  171. package/dist/core/detect.js.map +1 -0
  172. package/dist/core/i18n.js +103 -0
  173. package/dist/core/i18n.js.map +1 -0
  174. package/dist/core/integrity.js +46 -0
  175. package/dist/core/integrity.js.map +1 -0
  176. package/dist/core/manifest.js +18 -0
  177. package/dist/core/manifest.js.map +1 -0
  178. package/dist/core/prompts.js +20 -0
  179. package/dist/core/prompts.js.map +1 -0
  180. package/dist/core/registry.js +134 -0
  181. package/dist/core/registry.js.map +1 -0
  182. package/dist/core/rules.js +17 -0
  183. package/dist/core/rules.js.map +1 -0
  184. package/dist/core/scripts.js +40 -0
  185. package/dist/core/scripts.js.map +1 -0
  186. package/dist/core/skill-check.js +31 -0
  187. package/dist/core/skill-check.js.map +1 -0
  188. package/dist/core/skills.js +56 -0
  189. package/dist/core/skills.js.map +1 -0
  190. package/dist/core/state.js +43 -0
  191. package/dist/core/state.js.map +1 -0
  192. package/dist/types.js +2 -0
  193. package/dist/types.js.map +1 -0
  194. package/dist/utils/path.js +11 -0
  195. package/dist/utils/path.js.map +1 -0
  196. package/dist/utils/shell.js +29 -0
  197. package/dist/utils/shell.js.map +1 -0
  198. package/package.json +60 -0
@@ -0,0 +1,174 @@
1
+ # P0 基线任务模板
2
+
3
+ ## 为什么需要 P0
4
+
5
+ 复杂跨仓库需求中,实现 agent 经常在以下基线问题上出错:
6
+ - 工作树不干净,带着旧改动或脏文件开始开发
7
+ - 改了 SQL 但没同步改实体,字段不一致
8
+ - 改了实体但没同步改 Mapper/DTO,编译报错
9
+ - 不确定自己该改哪个仓库、哪个分支
10
+ - 业务和基线清理混在一起,难以回滚
11
+
12
+ P0 的目标:**在写任何业务代码之前,先把地基打牢**。
13
+
14
+ ---
15
+
16
+ ## P0 Prompt 模板
17
+
18
+ ```
19
+ 使用superpower技能,开启合适的团队,最少包含一名开发和一名测试交叉验证进行需求开发,测试验证闭环交付,更新测试文档和api.md:
20
+
21
+ # P0 Prompt:基线核查与开发准备
22
+
23
+ 你是 P0 基线 Agent,负责为后续业务开发建立干净、一致、可编译的基线。
24
+
25
+ ## 团队要求
26
+ - 至少 1 名开发 Worker
27
+ - 至少 1 名独立 Tester
28
+ - P0 完成后由 Tester 独立复核基线和编译结果
29
+
30
+ ## 本批目标
31
+ 建立可编译、字段一致的代码基线,确认开发环境就绪。
32
+
33
+ ## 并行开发要求(Worktree 隔离)
34
+
35
+ 本任务必须使用独立 git worktree 开分支开发,避免多个 agent 在同一工作树并行修改互相覆盖。
36
+
37
+ ```bash
38
+ git status --short
39
+ git worktree add -b feature/{change-id}-p0-baseline ../{project}-p0-worktree HEAD
40
+ cd ../{project}-p0-worktree
41
+ ```
42
+
43
+ 如果分支已存在,改用:
44
+
45
+ ```bash
46
+ git worktree add ../{project}-p0-worktree feature/{change-id}-p0-baseline
47
+ cd ../{project}-p0-worktree
48
+ ```
49
+
50
+ 所有基线核查、文档更新和提交都必须在该 worktree 内完成。不要在主工作树直接开发,不要回滚或删除其他 agent 的改动。完成后在报告中写明 worktree 路径、分支名和提交号。
51
+
52
+ ## 允许修改的仓库
53
+ {repository-name}
54
+
55
+ ## 允许修改的目录/文件范围
56
+ - SQL 文件:{sql-file-path}
57
+ - 实体类:{entity-package}/*.java
58
+ - Mapper 接口:{mapper-package}/*.java
59
+ - Mapper XML:{mapper-xml-path}/*.xml
60
+ - DTO:{dto-package}/*.java
61
+
62
+ ## 禁止修改的范围
63
+ - 禁止修改任何 Service/Controller/Listener 业务逻辑
64
+ - 禁止修改任何配置文件(application.yml 除外,如需调整数据库连接需上报)
65
+ - 禁止引入新的外部依赖
66
+ - 禁止提交 .DS_Store、target/、build/、.idea/ 等脏文件
67
+
68
+ ## 依赖的前置批次
69
+ 无(P0 是第一批次)
70
+
71
+ ## 执行步骤
72
+
73
+ ### 步骤 1:清理工作树
74
+ 1. 执行 `git status`,确认当前分支是 {branch-name}
75
+ 2. 如有未提交改动,先提交或暂存(stash)
76
+ 3. 检查并删除以下脏文件(如存在):
77
+ - .DS_Store
78
+ - target/
79
+ - build/
80
+ - *.iml
81
+ - .idea/(已跟踪的除外)
82
+ 4. 再次执行 `git status`,确认工作树干净
83
+
84
+ ### 步骤 2:确认仓库和分支
85
+ - 当前仓库:{repository-name}
86
+ - 目标分支:{branch-name}
87
+ - 允许改动范围:{allowed-paths}
88
+ - 远程跟踪:确认 `git branch -vv` 显示正确 upstream
89
+
90
+ ### 步骤 3:校验字段一致性
91
+ 对照 design.md 或 database-contract.md 中的表结构定义,逐一校验:
92
+
93
+ | 检查项 | 方法 | 通过标准 |
94
+ |--------|------|---------|
95
+ | SQL 表结构与实体类字段一致 | 对比 CREATE TABLE 与 @Column | 字段名、类型、长度、nullable 一致 |
96
+ | 实体类与 Mapper XML 一致 | 对比 resultMap / 列名 | 无遗漏字段、无拼写错误 |
97
+ | 实体类与 DTO 一致 | 对比字段列表 | DTO 字段是实体字段的子集或超集(设计意图明确) |
98
+ | 枚举值与数据库约束一致 | 对比 enum 定义与 CHECK 约束 | 枚举值在数据库约束范围内 |
99
+ | 主键/索引定义一致 | 对比 @Id/@Index 与 SQL | 主键、索引定义一致 |
100
+ | 版本总 SQL 收口一致 | 对比源码/Mapper、开发库、测试库现状+总 SQL | 源码依赖字段均在最终结构中存在;总 SQL 无漏项、无重复 ADD |
101
+
102
+ **校验方法**:
103
+ 1. 读取 SQL 文件,提取所有表结构和字段定义
104
+ 2. 读取对应的实体类,提取所有字段和注解
105
+ 3. 读取对应的 Mapper XML,提取所有 resultMap 和 SQL 列
106
+ 4. 读取对应的 DTO,提取所有字段
107
+ 5. 逐字段对比,列出不一致项
108
+ 6. 对涉及数据库的需求,额外对比三方:源码/Mapper 读写字段、开发库结构、测试库现状 + 版本总 SQL 执行后结构
109
+
110
+ ### 步骤 4:修复不一致
111
+ 对步骤 3 发现的不一致项:
112
+ - 如果 SQL 是正确的(以设计文档为准),修正实体/Mapper/DTO
113
+ - 如果源码/Mapper 和开发库一致但版本总 SQL 缺失,优先补版本总 SQL,不要改业务代码绕过
114
+ - 如果测试库已有字段,版本总 SQL 不得重复 ADD;字段类型或注释与开发库不一致时生成 MODIFY 或上报不采纳理由
115
+ - 如果设计文档有模糊之处,停止并报告,不允许自行猜测
116
+
117
+ ### 步骤 5:最小编译验证
118
+ 1. 执行 `git diff --name-only`,确认只修改了允许范围内的文件
119
+ 2. 执行编译命令:{compile-cmd}
120
+ 3. 确认 BUILD SUCCESS,无 ERROR
121
+
122
+ ## 数据库字段要求
123
+ - 所有新增/修改字段必须在 SQL、实体、Mapper、DTO 中同步存在
124
+ - 字段命名使用下划线(数据库)和驼峰(Java),转换由 MyBatis 负责
125
+ - 禁止使用数据库保留字作为字段名
126
+ - 时间字段统一使用 datetime,由框架填充
127
+
128
+ ## 验收命令
129
+ ```bash
130
+ # 1. 确认工作树干净
131
+ git status
132
+
133
+ # 2. 确认修改范围正确
134
+ git diff --name-only
135
+
136
+ # 3. 编译验证
137
+ {compile-cmd}
138
+
139
+ # 4. 检查无脏文件提交
140
+ git diff --cached --name-only | grep -v '\.java$\|\.xml$\|\.sql$' || echo "无异常文件"
141
+ ```
142
+
143
+ ## 完成后必须输出的报告
144
+
145
+ ```
146
+ P0 基线报告:
147
+ - 仓库:{repository-name}
148
+ - 分支:{branch-name}
149
+ - 工作树状态:干净 / 不干净(说明)
150
+ - 删除的脏文件:{list}
151
+ - 字段一致性校验结果:
152
+ - 检查表:{table-name}
153
+ - 一致字段:X 个
154
+ - 不一致字段:X 个(已修复 X 个,上报 X 个)
155
+ - 不一致详情:
156
+ - {field}: SQL={type}, Entity={type}, 修复方式={fix}
157
+ - 版本总 SQL 收口对账:
158
+ - 源码/Mapper vs 开发库:一致 / 不一致
159
+ - 测试库现状 + 总 SQL:一致 / 不一致
160
+ - 补入总 SQL 的字段/索引/数据:{list}
161
+ - 不采纳项及原因:{list}
162
+ - 编译状态:BUILD SUCCESS / 失败(说明)
163
+ - 修改文件清单:{files}
164
+ - 对应 OpenSpec 章节:design.md ## 数据模型
165
+ - 需要人工确认的问题:{list}
166
+ - 后续批次依赖事项:P1 可开始
167
+ ```
168
+
169
+ ## 偏离设计时必须停止并报告
170
+
171
+ - 如果发现 SQL 字段与设计文档定义不一致,**停止**,列出差异,上报 Leader
172
+ - 如果发现实体类使用了设计文档未定义的字段,**停止**,不允许自行添加
173
+ - 如果编译失败且无法通过修改允许范围内的文件解决,**停止**,上报 Leader
174
+ ```
@@ -0,0 +1,40 @@
1
+ # SDD Project Config
2
+
3
+ Use project-level `.sdd/config.yaml` for defaults that should apply to all SDD
4
+ changes in the repo.
5
+
6
+ ## Supported Fields
7
+
8
+ ```yaml
9
+ auto_transition: true # true|false
10
+ context_compression: off # off|beta
11
+ review_mode: standard # off|standard|thorough
12
+ ```
13
+
14
+ ## Precedence
15
+
16
+ Runtime scripts resolve configuration in this order:
17
+
18
+ 1. Environment variable:
19
+ - `SUPERFLOW_REVIEW_MODE`
20
+ - `SDD_AUTO_TRANSITION`
21
+ - `SDD_CONTEXT_COMPRESSION`
22
+ - `SDD_REVIEW_MODE`
23
+ 2. Change-local config: `<change-dir>/.sdd/config.yaml`
24
+ 3. Project config: `<repo-root>/.sdd/config.yaml`
25
+ 4. Existing state value when applicable
26
+ 5. Script default
27
+
28
+ ## Rules
29
+
30
+ - Use `auto_transition: false` when the user wants manual review between SDD
31
+ phases.
32
+ - Use `context_compression: beta` for large changes, long sessions, multi-agent
33
+ work, or repeated context compression risk.
34
+ - Use `review_mode: standard` for normal full workflow. Use `thorough` when the
35
+ change touches API contracts, database fields, cross-repo behavior, third-party
36
+ integrations, or production-like verification. Use `off` only for hotfix/tweak
37
+ flows or explicitly documented low-risk work.
38
+ - Beta handoff keeps `api.md`, `spec.md`, and `tests.md` projected while
39
+ supporting docs are referenced by hash. If a supporting detail is needed,
40
+ read the original source file.
@@ -0,0 +1,152 @@
1
+ # AI 提示词使用记录模板
2
+
3
+ 记录开发过程中使用的 AI 提示词、输出采纳情况和人工修改点,用于比赛交付或项目复盘。
4
+
5
+ ## 记录格式
6
+
7
+ 每个提示词记录为一个条目,按时间顺序排列。
8
+
9
+ ```markdown
10
+ # AI 提示词使用记录
11
+
12
+ ## 条目 N
13
+
14
+ ### 时间
15
+ 2026-05-09 10:30
16
+
17
+ ### 上下文
18
+ [描述当前正在解决什么问题,处于哪个开发阶段]
19
+
20
+ ### 原始提示词(Prompt)
21
+ ```
22
+ 完整的提示词内容
23
+ ```
24
+
25
+ ### AI 输出摘要
26
+ [AI 返回的核心内容,2-3 句话概括]
27
+
28
+ ### 采纳情况
29
+ - [x] 直接采纳(无需修改)
30
+ - [ ] 部分采纳(修改后使用)
31
+ - [ ] 未采纳(重新提问或人工解决)
32
+
33
+ ### 人工修改点
34
+ 如部分采纳,列出修改内容:
35
+ 1. 修改了 ____(原因:____)
36
+ 2. 删除了 ____(原因:____)
37
+ 3. 增加了 ____(原因:____)
38
+
39
+ ### 校验方式
40
+ [如何验证 AI 输出是否正确,如:编译通过 / 单元测试通过 / 人工 Review]
41
+
42
+ ### 经验教训
43
+ [如果 AI 输出有问题,记录问题原因和避免方式]
44
+ ```
45
+
46
+ ## 完整示例
47
+
48
+ ```markdown
49
+ # AI 提示词使用记录
50
+
51
+ ## 条目 1
52
+
53
+ ### 时间
54
+ 2026-05-09 09:00
55
+
56
+ ### 上下文
57
+ 需要设计门禁系统的数据库表结构,包含人员、门禁设备、通行记录。
58
+
59
+ ### 原始提示词
60
+ ```
61
+ 帮我设计一个人行门禁系统的数据库表结构,使用 MySQL。
62
+ 需要包含:
63
+ 1. 人员信息表(姓名、手机号、人脸特征、状态)
64
+ 2. 门禁设备表(设备编号、位置、状态)
65
+ 3. 通行记录表(人员、设备、时间、方式、结果)
66
+ 要求:
67
+ - 使用 InnoDB 引擎
68
+ - 有合适的索引
69
+ - 字段命名用下划线
70
+ - 包含 created_at / updated_at
71
+ ```
72
+
73
+ ### AI 输出摘要
74
+ 生成了 3 张表的 DDL,包含主键、索引、外键和注释。
75
+
76
+ ### 采纳情况
77
+ - [x] 部分采纳
78
+
79
+ ### 人工修改点
80
+ 1. 人脸特征字段从 TEXT 改为 VARCHAR(2048)(实际 base64 长度可控)
81
+ 2. 增加了 `tenant_id` 字段(多租户需求,AI 未考虑)
82
+ 3. 索引调整:通行记录增加 `(device_id, pass_time)` 联合索引(按设备查历史是高频操作)
83
+
84
+ ### 校验方式
85
+ - 在 MySQL 8.0 执行 DDL,确认无语法错误
86
+ - 使用 EXPLAIN 验证索引生效
87
+
88
+ ### 经验教训
89
+ AI 生成表结构时容易遗漏业务特定的字段(如 tenant_id),需要在提示词中明确说明业务背景。
90
+
91
+ ---
92
+
93
+ ## 条目 2
94
+
95
+ ### 时间
96
+ 2026-05-09 11:00
97
+
98
+ ### 上下文
99
+ 实现设备回调接口,处理门禁设备的刷卡事件。
100
+
101
+ ### 原始提示词
102
+ ```
103
+ 帮我写一个 Spring Boot Controller,接收门禁设备的回调请求。
104
+ 请求格式:
105
+ POST /device/callback
106
+ {
107
+ "deviceId": "string",
108
+ "cardNo": "string",
109
+ "timestamp": "2026-05-09T10:00:00Z",
110
+ "eventType": "CARD_SWIPE"
111
+ }
112
+
113
+ 需要:
114
+ 1. 校验 deviceId 存在
115
+ 2. 根据 cardNo 查询人员
116
+ 3. 判断是否有权限
117
+ 4. 记录通行日志
118
+ 5. 返回开门指令
119
+ ```
120
+
121
+ ### AI 输出摘要
122
+ 生成了 Controller + Service 代码,包含参数校验、业务逻辑、异常处理。
123
+
124
+ ### 采纳情况
125
+ - [x] 部分采纳
126
+
127
+ ### 人工修改点
128
+ 1. 增加了幂等性校验(相同 cardNo + timestamp 5 分钟内不重复处理)
129
+ 2. 使用分布式锁(Redisson)防止并发重复开门
130
+ 3. 将事务边界从 Controller 移到 Service 层
131
+
132
+ ### 校验方式
133
+ - 单元测试:Mock Service,验证参数校验逻辑
134
+ - 集成测试:启动应用,使用 curl 模拟回调,验证数据库记录
135
+
136
+ ### 经验教训
137
+ AI 生成的代码缺少并发安全考虑,涉及设备控制必须考虑幂等性和并发。
138
+ ```
139
+
140
+ ## 汇总统计
141
+
142
+ | 项目 | 数量 |
143
+ |------|------|
144
+ | 总提示词数 | __ |
145
+ | 直接采纳 | __ |
146
+ | 部分采纳 | __ |
147
+ | 未采纳 | __ |
148
+ | 平均修改点/条 | __ |
149
+
150
+ ## 质量总结
151
+
152
+ [整体评价 AI 辅助开发的效果,哪些场景效果好,哪些场景需要人工主导]