@agile-team/wl-skills-kit 2.5.2 → 2.7.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 (28) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/README.md +32 -4
  3. package/bin/wl-skills.js +48 -2
  4. package/docs/agent-pipeline-runbook.md +2 -1
  5. package/docs/ai/345/205/250/346/231/257/345/210/206/346/236/220.md +13 -4
  6. package/docs/mcp-tool-risk-matrix.md +2 -1
  7. package/docs//345/205/250/347/233/230/345/210/206/346/236/220/344/270/216/346/231/272/350/203/275/344/275/223/346/220/255/345/273/272/346/214/207/345/215/227.md +3 -2
  8. package/files/.github/copilot-instructions.md +2 -11
  9. package/files/.github/guides/architecture.md +1 -1
  10. package/files/.github/guides/usage.md +4 -3
  11. package/files/.github/skills/_compat/headers/cursor-mdc.txt +1 -1
  12. package/files/.github/skills/_compat/headers/kiro.txt +1 -1
  13. package/files/.github/skills/_compat/headers/trae.txt +1 -1
  14. package/files/.github/skills/_pipeline.md +10 -4
  15. package/files/.github/skills/_registry.md +3 -0
  16. package/files/.github/skills/core/business-doc-extract/SKILL.md +234 -0
  17. package/files/.github/skills/core/business-doc-extract/USAGE.md +176 -0
  18. package/files/.github/skills/core/business-doc-extract/templates/business-index.md +66 -0
  19. package/files/.github/skills/core/business-doc-extract/templates/business-open-questions.md +40 -0
  20. package/files/.github/skills/core/business-doc-extract/templates/module-dictionary.md +54 -0
  21. package/files/.github/skills/core/business-doc-extract/templates/module-field.md +63 -0
  22. package/files/.github/skills/core/business-doc-extract/templates/module-index.md +67 -0
  23. package/files/.github/skills/core/business-doc-extract/templates/module-requirement.md +101 -0
  24. package/files/.github/skills/ops/code-fix/USAGE.md +131 -0
  25. package/files/.github/skills/sync/dict-sync/USAGE.md +122 -0
  26. package/mcp/registry.js +368 -0
  27. package/mcp/server.js +65 -432
  28. package/package.json +9 -5
@@ -0,0 +1,234 @@
1
+ ---
2
+ name: business-doc-extract
3
+ description: "Use when: 用户提供原型目录(如已发布的 Axure HTML 文件夹)、详设/需求文档、字段或字典资料、已有页面目录等业务资料,并希望沉淀业务理解、对齐产品/后端、维护字段字典或维护待确认事项。Skill 不依赖固定关键词,依据资料源 + 用户意图 + 范围完整度智能判断;碎片化问答、单截图、小修小改默认不触发。Triggers on (语义级,仅作示例): 业务梳理 / 业务文档 / docs/business / 模块大纲 / 字段字典整理 / 待确认事项 / 产品确认 / 业务全景 / 原型转业务文档 / 详设转业务文档 / 业务闭环。"
4
+ ---
5
+
6
+ # Skill: 业务文档抽取(business-doc-extract)
7
+
8
+ 把 **原型 / 详设 / 字段字典 / 现有代码 / api.md / mock** 等业务资料沉淀为 **`docs/business`** 下的业务理解文档,作为 `api-contract` 和 `page-codegen` 的高质量输入,同时支撑产品/后端/前端的业务确认闭环。
9
+
10
+ > **核心理念**:固化但不僵化。本 Skill 不依赖死关键词;只在用户给出可识别的业务资料源、且范围达到模块/项目级时才会建议生成;碎片化任务默认不污染业务文档。
11
+
12
+ ---
13
+
14
+ ## 1. 何时触发
15
+
16
+ 不要把触发当成关键词匹配。请按下面 3 步判断:
17
+
18
+ 1. **资料源识别**:用户消息或工作区是否包含以下任一类:
19
+ - 已发布的 Axure / HTML 原型目录(推荐输入,最规范)
20
+ - 详细设计 / 需求说明 / PRD / 产品文档(md / docx / xlsx)
21
+ - 后端字段实体资料、字典资料表
22
+ - 现有页面目录 + `api.md` + mock(用于反向梳理)
23
+ 2. **意图识别**:用户的目标是否属于以下之一:
24
+ - 梳理业务、提取业务理解、生成业务文档
25
+ - 整理字段、字典、待确认事项
26
+ - 模块级 / 项目级业务沉淀
27
+ - 在生成代码前先和产品/后端确认
28
+ 3. **范围识别**:资料覆盖范围是否达到模块级或项目级。
29
+
30
+ 满足“资料源 + 意图 + 范围”三者,才进入本 Skill 的生成态。否则只输出对话级的业务理解片段,**不写入 `docs/business`**。
31
+
32
+ ---
33
+
34
+ ## 2. 决策矩阵
35
+
36
+ | 场景 | 默认行为 | 是否写入 `docs/business` |
37
+ |---|---|---|
38
+ | 用户明确说“生成业务文档 / 梳理业务 / 沉淀模块” | 进入生成态,给出计划,确认后写入 | 是(需确认) |
39
+ | 提供完整原型目录、完整详设、模块级页面集 | 建议生成 + 给出计划 | 否,先建议;用户确认后再写 |
40
+ | 提供字段表 / 字典表,目标是更新字段字典 | 进入增量更新态 | 是(仅更新对应模块的 `field.md` / `dictionary.md`,其他不动) |
41
+ | 已有 `docs/business`,用户提交新增需求 | 进入增量维护态 | 是(仅追加/更新涉及模块) |
42
+ | 单页面口述需求 / 单截图 | 不触发本 Skill | 否(仅输出页面理解、`api.md` 草案、必要时 preview) |
43
+ | 小修小改、报错调试、样式调整 | 不触发本 Skill | 否 |
44
+ | 用户要求 “先 mock 能跑” | 不阻塞 page-codegen | 否(保持轻量路径) |
45
+
46
+ > **缺资料时**:先询问用户提供资料路径,不要凭口述硬生成业务文档。
47
+
48
+ ---
49
+
50
+ ## 3. 输出结构
51
+
52
+ ### 3.1 模块级(推荐,最常用)
53
+
54
+ ```text
55
+ docs/business/
56
+ ├── index.md # 业务全景 + 模块索引 + 实现状态
57
+ ├── open-questions.md # 全局待确认问题汇总
58
+ └── 0X-<module-kebab>/
59
+ ├── index.md # 模块全景 + 页面/API 索引
60
+ ├── requirement.md # 需求理解 + 业务流程 + 页面清单 + 模块待确认
61
+ ├── dictionary.md # 字典枚举
62
+ └── field.md # 字段清单
63
+ ```
64
+
65
+ > 模块目录使用 `01-`、`02-` 顺序前缀,便于阅读和约定排序。
66
+
67
+ ### 3.2 文件职责
68
+
69
+ | 文件 | 职责 | 不放什么 |
70
+ |---|---|---|
71
+ | `docs/business/index.md` | 项目业务定位、一级模块总览、产品目录 ↔ 代码目录映射、整体实现状态、链接 | 详细需求、字段、字典 |
72
+ | `docs/business/open-questions.md` | 跨模块待确认问题汇总表 | 模块内详细规则 |
73
+ | `0X-xx/index.md` | 模块定位、子功能清单、页面与 `api.md` 链接、模块链路摘要 | 详细需求与字段 |
74
+ | `0X-xx/requirement.md` | 需求来源、业务目标、角色、功能范围、流程图、页面清单、业务规则、异常规则、**模块待确认** | 字典/字段大表 |
75
+ | `0X-xx/dictionary.md` | 模块涉及字典 / 枚举 / 状态 | 与字典无关的字段 |
76
+ | `0X-xx/field.md` | 模块涉及业务字段、来源、使用位置 | 字典 |
77
+
78
+ ### 3.3 与现有产物的边界
79
+
80
+ - **页面级 `api.md` 不搬家**:仍然位于 `src/views/**/api.md`,是接口契约的唯一详细位置;模块 `index.md` 只做链接索引。
81
+ - **mock 不动**:仍位于 `mock/`,是页面运行依赖。
82
+ - **`reports/SYS_*` 不动**:菜单/字典/权限基线仍归 sync 类 Skill。
83
+
84
+ ---
85
+
86
+ ## 4. 生成模式
87
+
88
+ | 模式 | 说明 | 落盘 |
89
+ |---|---|---|
90
+ | `preview` | 仅在对话中输出业务理解、待确认点、推荐结构 | 否 |
91
+ | `module` | 生成或增量更新单个 `0X-xx/` 模块文档 | 是(需用户确认) |
92
+ | `project` | 生成或刷新 `docs/business/index.md` + `open-questions.md` 全局总览 | 是(需用户确认) |
93
+ | `incremental` | 基于字段表 / 字典表 / 新需求局部增量更新已有模块文档 | 是(需用户确认) |
94
+
95
+ > Skill 不要求显式传入模式;AI 应根据资料源和意图自动判断,并在 Pre-flight 中说明。
96
+
97
+ ---
98
+
99
+ ## 5. Pre-flight 声明(必须输出)
100
+
101
+ ```text
102
+ 🚀 已触发技能 business-doc-extract/SKILL.md → 业务理解文档抽取与维护
103
+ ✅ 已识别资料源:{原型目录 / 详设文件 / 字段表 / 字典表 / 现有代码 + api.md}
104
+ ✅ 已判断范围:{preview / module / project / incremental}
105
+ ✅ 已读取 standards/index.md → 任务类型 D(参考结构与组件合规)
106
+ ✅ 已读取 _pipeline.md → 与 prototype-scan / api-contract / page-codegen 的衔接关系
107
+ ✅ 计划落盘:{是/否},目标路径:{docs/business/...}
108
+ ⚠ 涉及写文件:是/否;需要用户确认:是/否
109
+ ```
110
+
111
+ 资料缺失时必须暂停:
112
+
113
+ ```text
114
+ ❌ 资料源不足:未发现可用的原型目录 / 详设文档 / 字段资料 / 现有页面 + api.md
115
+ → 请提供以下任一资料路径:
116
+ 1. 已发布的 Axure HTML 原型目录
117
+ 2. 详细设计 / 需求文档(md / docx / xlsx)
118
+ 3. 字段实体资料、字典资料表
119
+ 4. 已有页面目录与 api.md
120
+ → 或继续走 page-codegen 模式 0(口述需求 → 页面骨架 + mock,不生成业务文档)
121
+ ⛔ 业务文档未写入,等待资料补充。
122
+ ```
123
+
124
+ ---
125
+
126
+ ## 6. 工作流
127
+
128
+ ### 6.1 模块级(最常用)
129
+
130
+ 1. 读取资料(原型 HTML / 详设 / 字段实体 / 现有 `api.md` / mock)。
131
+ 2. 拆模块:把内容归类到 `0X-<module-kebab>`,使用产品目录或现有 `src/views/<域>/<模块>` 一级目录命名。
132
+ 3. 生成 4 个模块文件:
133
+ - `index.md`
134
+ - `requirement.md`
135
+ - `dictionary.md`
136
+ - `field.md`
137
+ 4. 更新 `docs/business/index.md`:补充模块行、状态、链接。
138
+ 5. 更新 `docs/business/open-questions.md`:把模块 `requirement.md` 底部的待确认事项汇总到全局表,标注来源文件。
139
+ 6. 输出完成摘要 + `next_suggest`。
140
+
141
+ ### 6.2 增量更新
142
+
143
+ 1. 检测 `docs/business` 已存在哪些模块。
144
+ 2. 对应模块若已存在 `dictionary.md` / `field.md`:
145
+ - 仅追加新增项,并标注 `新增` 或 `更新`。
146
+ - 已废弃项标 `已废弃`,不直接删除。
147
+ 3. 对应模块若不存在:
148
+ - 询问归属,确认后再创建模块目录。
149
+ 4. 同步刷新 `docs/business/index.md` 与 `open-questions.md`。
150
+
151
+ ### 6.3 项目级刷新
152
+
153
+ 1. 重新扫描 `docs/business/0X-*`,重建:
154
+ - `docs/business/index.md` 模块表
155
+ - `docs/business/open-questions.md` 汇总表
156
+ 2. 不删除模块文件本身。
157
+ 3. 给出本次新增 / 状态变更 / 已废弃模块清单。
158
+
159
+ ---
160
+
161
+ ## 7. 文件骨架(生成时遵循)
162
+
163
+ > Skill 同目录下的 `templates/` 提供可复用的最小骨架,AI 必须读取后再生成。
164
+
165
+ | 模板 | 路径 | 适用 |
166
+ |---|---|---|
167
+ | 项目业务全景 | `templates/business-index.md` | `docs/business/index.md` |
168
+ | 全局待确认 | `templates/business-open-questions.md` | `docs/business/open-questions.md` |
169
+ | 模块全景 | `templates/module-index.md` | `0X-xx/index.md` |
170
+ | 模块需求理解 | `templates/module-requirement.md` | `0X-xx/requirement.md` |
171
+ | 模块字典 | `templates/module-dictionary.md` | `0X-xx/dictionary.md` |
172
+ | 模块字段 | `templates/module-field.md` | `0X-xx/field.md` |
173
+
174
+ > 骨架仅作初始结构,**禁止**把模板里的占位内容直接当作真实业务事实输出。
175
+
176
+ ---
177
+
178
+ ## 8. 与其他 Skill 的衔接
179
+
180
+ | 上游 | 关系 |
181
+ |---|---|
182
+ | `prototype-scan` | 先扫描原型/详设拿到 page-spec,再由本 Skill 提炼模块需求 |
183
+ | 用户口述 + 资料指向 | 直接进入本 Skill 的 `preview` 或 `incremental` 模式 |
184
+
185
+ | 下游 | 关系 |
186
+ |---|---|
187
+ | `api-contract` | 基于 `requirement.md` + `field.md` 生成更准确的 `api.md` |
188
+ | `page-codegen` | 优先读取已有 `requirement.md` / `dictionary.md` / `field.md` 来减少臆造 |
189
+ | `dict-sync` | `dictionary.md` 可作为字典 query/upsert 前的业务对照 |
190
+ | `permission-sync` | 模块 `requirement.md` 的角色/权限部分可辅助权限规划 |
191
+ | `convention-audit` | 不直接耦合,本 Skill 不替代规范审计 |
192
+
193
+ ---
194
+
195
+ ## 9. 完成摘要(必须输出)
196
+
197
+ ```text
198
+ ## 完成摘要
199
+ - 模式:preview / module / project / incremental
200
+ - 资料源:{文件或目录列表}
201
+ - 输出:
202
+ - docs/business/index.md(更新行:N)
203
+ - docs/business/open-questions.md(新增问题:N)
204
+ - docs/business/0X-xx/index.md
205
+ - docs/business/0X-xx/requirement.md
206
+ - docs/business/0X-xx/dictionary.md
207
+ - docs/business/0X-xx/field.md
208
+ - 风险:{产品需确认 N 项 / 后端需确认 N 项}
209
+
210
+ ## 建议下一步
211
+ - next_suggest:api-contract / page-codegen / dict-sync / permission-sync
212
+ - 原因:{为什么是这一步}
213
+ - 是否需要用户确认:是
214
+ ```
215
+
216
+ ---
217
+
218
+ ## 10. 边界与约束
219
+
220
+ - **不替代页面级 `api.md`**:详细接口契约仍写在页面目录的 `api.md`,模块 `index.md` 只放链接。
221
+ - **不写非业务文档**:本 Skill 不维护 `README.md`、`docs/agent-pipeline-runbook.md`、`docs/mcp-tool-risk-matrix.md`、`docs/全盘分析与智能体搭建指南.md`。
222
+ - **不自动确认产品 / 后端问题**:所有 “待确认事项” 必须保留并汇总到 `open-questions.md`。
223
+ - **不删除既有事实条目**:仅做追加 / 标注 `已废弃`。
224
+ - **不污染碎片场景**:单截图、小修小改、口述简单页面默认不写 `docs/business`。
225
+ - **不引入新关键词列表**:触发完全依赖资料源 + 意图 + 范围;不要在外部文件维护“关键词清单 → 触发”表。
226
+
227
+ ---
228
+
229
+ ## 11. 不在本轮范围
230
+
231
+ - 跨项目业务知识库共享。
232
+ - Multi-Agent 业务理解协作。
233
+ - 自动从聊天历史回溯生成业务文档。
234
+ - 自动覆盖业务规则结论(必须保持人工 review)。
@@ -0,0 +1,176 @@
1
+ # 使用指南:business-doc-extract(业务文档抽取)
2
+
3
+ > **谁读这个文档**:团队成员(产品/前端/后端)
4
+ > **AI 触发文件**:同目录 `SKILL.md`(无需手动阅读)
5
+
6
+ ---
7
+
8
+ ## 1. 这个 Skill 解决什么问题
9
+
10
+ 把零散的业务资料(已发布原型、详设、字段表、字典表、现有页面)沉淀为:
11
+
12
+ ```text
13
+ docs/business/
14
+ ├── index.md # 项目业务全景 + 模块索引
15
+ ├── open-questions.md # 全局待确认问题汇总
16
+ └── 01-xxx/ # 模块文档
17
+ ├── index.md # 模块全景 + 页面/API 索引
18
+ ├── requirement.md # 需求理解 + 流程 + 页面清单 + 模块待确认
19
+ ├── dictionary.md # 字典枚举
20
+ └── field.md # 字段清单
21
+ ```
22
+
23
+ 让产品、后端、前端基于同一份业务理解协作,避免:
24
+
25
+ - AI 凭原型截图猜业务规则
26
+ - 页面生成后字段对不齐后端实体
27
+ - 字典 code 在 mock / 后端 / 前端各写各的
28
+ - 待确认问题散落在聊天记录里,没法跟产品对齐
29
+
30
+ ---
31
+
32
+ ## 2. 什么时候会触发
33
+
34
+ 不靠死关键词。AI 只在满足以下条件时**建议**生成:
35
+
36
+ 1. 你提供了可识别的业务资料:
37
+ - 已发布的 Axure HTML 原型目录
38
+ - 详设 / 需求 / PRD(md / docx / xlsx)
39
+ - 后端字段实体、字典资料表
40
+ - 已有页面目录 + `api.md` + mock
41
+ 2. 资料范围达到模块或项目级(不是单页面/单截图)。
42
+ 3. 你的目标是“梳理业务 / 沉淀文档 / 整理字段字典 / 确认待确认事项”。
43
+
44
+ > 单页面口述、单截图、改样式、修 bug 等碎片化任务,**默认不会写 `docs/business`**,避免污染。
45
+
46
+ ---
47
+
48
+ ## 3. 触发示例(语义级)
49
+
50
+ 下面这些自然表达 AI 会自动判断走 business-doc-extract:
51
+
52
+ ```
53
+ 帮我梳理 docs/prototypes/客户管理 这个原型,按业务文档结构沉淀。
54
+ 基于 docs/spec/主数据需求.md 把模块文档生成出来,再聊页面。
55
+ 我把字段实体放在 字段/ 目录,帮我把模块字典和字段同步进 docs/business。
56
+ 现有 src/views/mdata 已经写完了,回过头帮我生成 docs/business 业务文档。
57
+ ```
58
+
59
+ 下面这些不会触发:
60
+
61
+ ```
62
+ 帮我做个客户档案页面(默认走 page-codegen,不写业务文档)
63
+ 照这张截图做个表格
64
+ 这个按钮点了报错怎么改
65
+ ```
66
+
67
+ ---
68
+
69
+ ## 4. 推荐工作流
70
+
71
+ ### 4.1 模块从零沉淀
72
+
73
+ ```
74
+ 你:
75
+ docs/prototypes/客户管理/ 已发布的 Axure 原型在这里,
76
+ 请按业务文档最佳实践沉淀,目标是 docs/business/01-customer。
77
+
78
+ AI:
79
+ [识别资料源 → 输出 Pre-flight → 给出生成计划 → 等待你确认]
80
+ ```
81
+
82
+ 确认后产物:
83
+
84
+ ```text
85
+ docs/business/index.md
86
+ docs/business/open-questions.md
87
+ docs/business/01-customer/index.md
88
+ docs/business/01-customer/requirement.md
89
+ docs/business/01-customer/dictionary.md
90
+ docs/business/01-customer/field.md
91
+ ```
92
+
93
+ ### 4.2 增量补字段或字典
94
+
95
+ ```
96
+ 你:
97
+ 后端补了 6 个字段,资料在 字段/MdmModelAttribute.md,
98
+ 帮我合并进 docs/business/01-model/field.md。
99
+
100
+ AI:
101
+ [读取字段表 → 仅更新 field.md,新增标注“新增”或“更新”]
102
+ ```
103
+
104
+ 不会乱碰其他模块文件。
105
+
106
+ ### 4.3 反向梳理已有项目
107
+
108
+ ```
109
+ 你:
110
+ src/views/mdata 已经全部写完了,但没有业务文档,
111
+ 帮我反向沉淀 docs/business 模块文档,标出待确认事项。
112
+
113
+ AI:
114
+ [扫描 src/views + api.md + mock + 字段资料]
115
+ [生成模块文档 + 在 open-questions.md 列出待和产品/后端对齐的项]
116
+ ```
117
+
118
+ ---
119
+
120
+ ## 5. 与页面 `api.md` 的关系
121
+
122
+ 页面级接口契约仍然放在页面目录:
123
+
124
+ ```text
125
+ src/views/mdata/model/mdata-model-config/api.md
126
+ ```
127
+
128
+ 模块 `index.md` 只做索引:
129
+
130
+ ```md
131
+ | 页面 | 代码目录 | API 契约 |
132
+ |---|---|---|
133
+ | 主数据模型配置 | src/views/mdata/model/mdata-model-config | src/views/mdata/model/mdata-model-config/api.md |
134
+ ```
135
+
136
+ 不在 `docs/business` 里重复维护接口字段。
137
+
138
+ ---
139
+
140
+ ## 6. 输出物用法
141
+
142
+ | 文件 | 给谁看 | 何时更新 |
143
+ |---|---|---|
144
+ | `docs/business/index.md` | 产品 / 项目经理 / 新成员 | 模块新增 / 状态变化时 |
145
+ | `docs/business/open-questions.md` | 产品 / 后端 / 前端联调会 | 每次发现待确认事项 |
146
+ | `0X-xx/index.md` | 模块 owner | 模块结构有调整时 |
147
+ | `0X-xx/requirement.md` | 业务侧 + 实施侧 | 需求确认 / 流程调整 |
148
+ | `0X-xx/dictionary.md` | 后端字典 + 前端 dict | 字典 code 确认 / 新增 |
149
+ | `0X-xx/field.md` | 后端实体 + 前端 data.ts | 字段新增 / 类型调整 |
150
+
151
+ ---
152
+
153
+ ## 7. 常见踩坑
154
+
155
+ | 现象 | 原因 | 解法 |
156
+ |---|---|---|
157
+ | AI 把单页面口述写进了 `docs/business` | 资料源不足却被强制走 | 检查是否提供了模块级资料;只是做单页时直接走 page-codegen |
158
+ | 生成的字段表里有“推断字段”污染真实事实 | 资料缺失 | 让 AI 把推断字段全部标注 `待确认`,不要直接合并到 field.md 主表 |
159
+ | open-questions 越来越多 | 没有定期与产品对齐 | 周会上集中确认后,把已确认项移除并在 requirement.md 落地业务规则 |
160
+ | 模块目录命名混乱 | 没有按 `0X-` 顺序前缀 | 强制要求 `01-`、`02-`,与产品一级目录一致 |
161
+
162
+ ---
163
+
164
+ ## 8. FAQ
165
+
166
+ **Q:小项目也要 `docs/business` 吗?**
167
+ A:不强求。小项目可以把业务全景写在 README,不需要拆成 `docs/business`。本 Skill 不会主动给小项目写。
168
+
169
+ **Q:原型目录必须发布成 HTML 吗?**
170
+ A:推荐已发布的 Axure HTML,AI 可以读取具体页面。其他形式(pdf / docx / 截图集)也支持,但识别精度下降。
171
+
172
+ **Q:能不能只做 preview,不落盘?**
173
+ A:可以。直接告诉 AI “只预览,不写文件”,AI 会在对话里输出业务理解结构和待确认事项。
174
+
175
+ **Q:和 page-codegen 冲突吗?**
176
+ A:不冲突。page-codegen 仍然支持口述需求 / 截图直接生成页面;本 Skill 只在你想沉淀业务文档时介入。
@@ -0,0 +1,66 @@
1
+ <!--
2
+ 模板:docs/business/index.md(项目业务全景)
3
+ 使用:business-doc-extract Skill 在 project / module 模式下生成或刷新此文件。
4
+ 约束:表格中的页面数量 / 状态需基于真实资料填充,禁止凭空推断。
5
+ -->
6
+
7
+ # {{ProjectName}} 业务全景
8
+
9
+ > **版本基线**:{{BaselineVersion}}
10
+ > **最近更新**:{{UpdatedAt}}
11
+ > **维护者**:{{Maintainer}}
12
+
13
+ ---
14
+
15
+ ## 1. 系统定位
16
+
17
+ {{SystemPositioning}}
18
+
19
+ ---
20
+
21
+ ## 2. 一级业务模块
22
+
23
+ | 序号 | 模块 | 代码目录 | 文档 | 当前状态 |
24
+ |---|---|---|---|---|
25
+ | 01 | {{Module1Name}} | `src/views/{{module1-path}}` | [01-{{module1-kebab}}/index.md](./01-{{module1-kebab}}/index.md) | {{Module1Status}} |
26
+ | 02 | {{Module2Name}} | `src/views/{{module2-path}}` | [02-{{module2-kebab}}/index.md](./02-{{module2-kebab}}/index.md) | {{Module2Status}} |
27
+
28
+ ---
29
+
30
+ ## 3. 业务主链路
31
+
32
+ ```mermaid
33
+ flowchart LR
34
+ A[{{Step1}}] --> B[{{Step2}}]
35
+ B --> C[{{Step3}}]
36
+ C --> D[{{Step4}}]
37
+ ```
38
+
39
+ ---
40
+
41
+ ## 4. 模块关系
42
+
43
+ ```mermaid
44
+ flowchart TD
45
+ M01[{{Module1Name}}] --> M02[{{Module2Name}}]
46
+ M02 --> M03[{{Module3Name}}]
47
+ ```
48
+
49
+ ---
50
+
51
+ ## 5. 实现状态摘要
52
+
53
+ | 维度 | 状态 |
54
+ |---|---|
55
+ | 已实现页面 | {{ImplementedPages}} |
56
+ | 文档化模块 | {{DocumentedModules}} |
57
+ | 待确认事项 | 详见 [open-questions.md](./open-questions.md) |
58
+
59
+ ---
60
+
61
+ ## 6. 阅读指南
62
+
63
+ - 想了解整个系统:从本文件起步。
64
+ - 想了解某个业务模块:进入 `0X-xxx/index.md`。
65
+ - 想看接口契约:进入对应页面目录的 `api.md`。
66
+ - 想看待确认事项:查看 `open-questions.md`。
@@ -0,0 +1,40 @@
1
+ <!--
2
+ 模板:docs/business/open-questions.md(全局待确认事项汇总)
3
+ 使用:business-doc-extract Skill 在每次生成或更新模块 requirement.md 后,把模块底部的待确认事项汇总到本文件。
4
+ 约束:仅做汇总和索引;模块内详细规则不在此处展开。
5
+ -->
6
+
7
+ # 全局待确认事项
8
+
9
+ > 来源:各模块 `0X-xx/requirement.md` 底部待确认事项。
10
+ > 用途:产品 / 后端 / 前端定期对齐。
11
+ > 状态:`待确认` / `已确认` / `已废弃`。
12
+
13
+ ---
14
+
15
+ ## 1. 汇总表
16
+
17
+ | 编号 | 模块 | 问题 | 影响 | 建议确认人 | 优先级 | 状态 | 来源 |
18
+ |---|---|---|---|---|---|---|---|
19
+ | Q-001 | {{Module}} | {{Question}} | {{Impact}} | 产品 / 后端 / 前端 | 高 / 中 / 低 | 待确认 | `0X-xx/requirement.md` |
20
+ | Q-002 | {{Module}} | {{Question}} | {{Impact}} | {{Owner}} | {{Priority}} | {{Status}} | `0X-xx/requirement.md` |
21
+
22
+ ---
23
+
24
+ ## 2. 处理规则
25
+
26
+ | 行为 | 要求 |
27
+ |---|---|
28
+ | 新增问题 | 编号顺序累加,不复用废弃编号 |
29
+ | 状态变更 | 仅修改 `状态` 列,不删除已废弃条目 |
30
+ | 已确认 | 在对应模块 `requirement.md` 中落地为业务规则 |
31
+ | 已废弃 | 标注废弃原因(产品取消 / 改为他模块 / 范围变更) |
32
+
33
+ ---
34
+
35
+ ## 3. 推荐节奏
36
+
37
+ - 每周 / 每两周一次跨角色对齐会。
38
+ - 高优问题阻断当周代码生成或菜单/字典/权限同步。
39
+ - 中优问题在版本计划阶段集中确认。
40
+ - 低优问题可挂起,但不删除。
@@ -0,0 +1,54 @@
1
+ <!--
2
+ 模板:docs/business/0X-xxx/dictionary.md(模块字典枚举)
3
+ 使用:business-doc-extract Skill 在 module / incremental 模式下生成或更新。
4
+ 约束:仅维护本模块涉及的字典 / 枚举 / 状态;跨模块共享的字典需在备注列说明。
5
+ 字典 code 推断未确认时,必须在 `状态` 列标 `待确认`,确认前不写入业务代码。
6
+ -->
7
+
8
+ # {{ModuleName}}:字典与枚举
9
+
10
+ ---
11
+
12
+ ## 1. 模块字典清单
13
+
14
+ | 字典 code | 字典名称 | 用途 | 来源 | 状态 | 备注 |
15
+ |---|---|---|---|---|---|
16
+ | {{DictCode1}} | {{DictName1}} | {{Usage1}} | 原型 / 详设 / 后端 | 待确认 / 已确认 / 已废弃 | {{Note1}} |
17
+ | {{DictCode2}} | {{DictName2}} | {{Usage2}} | {{Source2}} | {{Status2}} | {{Note2}} |
18
+
19
+ ---
20
+
21
+ ## 2. 字典项明细
22
+
23
+ ### {{DictCode1}}:{{DictName1}}
24
+
25
+ | 值 | 标签 | 说明 | 状态 |
26
+ |---|---|---|---|
27
+ | {{Value1}} | {{Label1}} | {{Desc1}} | 待确认 / 已确认 |
28
+ | {{Value2}} | {{Label2}} | {{Desc2}} | {{Status2}} |
29
+
30
+ ---
31
+
32
+ ## 3. 跨模块共享字典
33
+
34
+ > 如本模块依赖其他模块或平台通用字典,列在此表,避免重复维护。
35
+
36
+ | 字典 code | 维护方 | 使用页面 |
37
+ |---|---|---|
38
+ | {{ShareCode}} | {{Owner}} | {{Pages}} |
39
+
40
+ ---
41
+
42
+ ## 4. 与后端 / mock 的对齐情况
43
+
44
+ | 字典 code | 后端字典模块 | mock 是否覆盖 | 前端 dict 引用位置 | 是否一致 |
45
+ |---|---|---|---|---|
46
+ | {{DictCode}} | {{BackendModule}} | 是 / 否 | `data.ts` / `select.dictCode` | 是 / 否 |
47
+
48
+ ---
49
+
50
+ ## 5. 变更记录
51
+
52
+ | 日期 | 摘要 | 操作人 |
53
+ |---|---|---|
54
+ | {{Date}} | {{Summary}} | {{Operator}} |
@@ -0,0 +1,63 @@
1
+ <!--
2
+ 模板:docs/business/0X-xxx/field.md(模块字段清单)
3
+ 使用:business-doc-extract Skill 在 module / incremental 模式下生成或更新。
4
+ 约束:以业务字段为主,配合后端实体、前端 data.ts、api.md 多端对齐。
5
+ 字段类型未确认时必须标 `待确认`,禁止凭推断写入。
6
+ -->
7
+
8
+ # {{ModuleName}}:业务字段清单
9
+
10
+ ---
11
+
12
+ ## 1. 字段总表
13
+
14
+ | 字段 | 中文名 | 类型 | 必填 | 字典 | 来源 | 使用位置 | 备注 |
15
+ |---|---|---|---|---|---|---|---|
16
+ | {{Field1}} | {{Cn1}} | {{Type1}} | 是 / 否 | {{DictCode1}} | 原型 / 详设 / 后端实体 / api.md | 列表列 / 查询项 / 表单项 / 接口入参 | {{Note1}} |
17
+ | {{Field2}} | {{Cn2}} | {{Type2}} | {{Required2}} | {{DictCode2}} | {{Source2}} | {{Position2}} | {{Note2}} |
18
+
19
+ ---
20
+
21
+ ## 2. 后端实体对照
22
+
23
+ > 仅列出与本模块相关的后端实体,避免文档膨胀。
24
+
25
+ ### {{EntityName1}}
26
+
27
+ | 前端字段 | 数据库字段 | 类型 | 说明 | 字典 / 约束 |
28
+ |---|---|---|---|---|
29
+ | {{Field1}} | {{Column1}} | {{Type1}} | {{Desc1}} | {{Constraint1}} |
30
+
31
+ ---
32
+
33
+ ## 3. 字段一致性检查
34
+
35
+ | 字段 | 后端实体 | mock | api.md | data.ts | 是否一致 |
36
+ |---|---|---|---|---|---|
37
+ | {{Field}} | {{InEntity}} | 是 / 否 | 是 / 否 | 是 / 否 | 是 / 否 |
38
+
39
+ ---
40
+
41
+ ## 4. 业务规则
42
+
43
+ | 字段 | 校验 / 规则 | 说明 |
44
+ |---|---|---|
45
+ | {{Field}} | 必填 / 唯一 / 长度 / 范围 / 正则 | {{Desc}} |
46
+
47
+ ---
48
+
49
+ ## 5. 待确认字段
50
+
51
+ > 推断字段不直接进入字段总表,先放在此处,确认后再合并。
52
+
53
+ | 字段 | 推断来源 | 待确认问题 | 建议确认人 | 状态 |
54
+ |---|---|---|---|---|
55
+ | {{Field}} | 原型 / 截图 | {{Question}} | 后端 / 产品 | 待确认 |
56
+
57
+ ---
58
+
59
+ ## 6. 变更记录
60
+
61
+ | 日期 | 摘要 | 操作人 |
62
+ |---|---|---|
63
+ | {{Date}} | {{Summary}} | {{Operator}} |