to-brd

Name: to-brd
Author: BlueprintOS

24stars2forks

How to install to-brd?

blueprintos/analysis-to-delivery/to-brd

$npx -y skills add BlueprintOS/analysis-to-delivery --skill to-brd

Installs into the current project.

Summary

生成业务需求文档(BRD)— 含业务流程图、角色职责、功能模块、字段映射表。业务需求需正式文档化交付给团队评审时调用本 skill,把 TASK_CONFIRM 翻译为 9 节齐备的 BRD。

Files · 1

View on GitHub

SKILL.md

1	# To-BRD — 业务需求文档生成
2
3	## Contract
4
5	- 输入: 已签字的 `TASK_CONFIRM_*.md`、`REVIEW_需求确认书.md`、`REVIEW_字段对齐分析.md`、`paths/knowledge-path.md`
6	- 输出: `01-业务需求文档 BRD.md`、ASCII 流程图、可选 `业务流程图.drawio`
7	- 门控: BRD 必备章节齐全;字段映射与知识库核对;用户签字
8	- Required rules: `stage-gate`, `no-field-guessing`, `ascii-flowchart`, `doc-numbering`, `goal-boundary`
9	- Required paths: `knowledge-path`, `doc-naming-path`
10	- 下一步: `/compliance-review`
11
12	## 适用场景
13
14	- TASK_CONFIRM 和字段对齐分析已通过
15	- 需要把业务需求整理成 BRD 交给团队评审
16	- 需要画业务流程图 / 状态流转图
17
18	## 流程步骤
19
20	### 1. 加载模板
21
22	- `templates/BRD.md`(9 节必备章节)
23
24	### 2. 填充内容
25
26	按 BRD 模板逐节生成:
27
28	\| 章节 \| 内容来源 \|
29	\|---\|---\|
30	\| 一、项目概述 \| TASK_CONFIRM §1-3 \|
31	\| 二、角色与职责 \| 业务调研 \|
32	\| 三、业务流程 \| ASCII 流程图 / drawio \|
33	\| 四、功能模块 \| TASK_CONFIRM §功能描述 \|
34	\| 五、数据要求 \| 字段对齐分析 + 知识库 \|
35	\| 六、合规要点 \| 预留,阶段 4 填 \|
36	\| 七、非功能需求 \| 性能/可靠性/安全/可维护性 \|
37	\| 八、风险与约束 \| 团队约束 + 外部依赖 \|
38	\| 九、上线计划 \| 团队节奏 \|
39
40	### 3. 画流程图
41
42	- 状态流转图:ASCII(参考 `rules/ascii-flowchart.md`)
43	- 业务流程图:简单用 ASCII,复杂用 drawio
44	- 泳道图:ASCII(角色分工清晰)
45
46	### 4. 字段映射表
47
48	把字段对齐分析里的 ✅ 项固化到 BRD §五.3:
49
50	\| 业务概念 \| 字段 \| 备注 \|
51	\|---\|---\|---\|
52	\| ASN 单号 \| `ASN.TC_ASN_ID` \| ❌ 严禁用 ASN_NBR \|
53
54	### 5. DB 验证(如涉及)
55
56	- 仅允许 `SELECT` 查询
57	- 用 `desc table_name` 验证字段定义
58	- 严禁任何 DDL/DML 写操作
59
60	## 输出
61
62	- `01-业务需求文档 BRD.md`
63	- `业务流程图-状态流转.txt`(ASCII)
64	- `业务流程图-收货流程.txt`(如需要,泳道图)
65	- `业务流程图.drawio`(可选,用于可视化)
66
67	## 调用的 rule
68
69	- `rules/ascii-flowchart` — 流程图规范
70	- `rules/no-field-guessing` — 字段名必须查知识库
71	- `rules/doc-numbering` — 文档编号 01
72
73	## 结束条件
74
75	- [ ] BRD 9 个必备章节齐
76	- [ ] ASCII 流程图 + 状态流转图
77	- [ ] 字段映射表通过 `field-alignment-check.py`
78	- [ ] 用户签字进入阶段 4
79
80	## 反模式
81
82	- ❌ 用 Mermaid 写流程图 — 必须 ASCII(参考 rules/ascii-flowchart.md);可视化交付经 `flow-to-mermaid.py --ascii-strict`
83	- ❌ 泳道图回流箭头散乱 — 必须汇聚到同一目标节点(回流闭环强制)
84	- ❌ 字段映射表缺知识库来源 — 每条字段必须标"WMOS 知识库/XX 章"或"项目侧 schema"
85	- ❌ 9 章节缺一 — `brd-check.py --strict` 必须 exit 0
86	- ❌ 写完不跑 `field-alignment-check.py` — 应在签字前自动跑一遍,errors=0 才签字
87	- ❌ 流程图用真实人名/客户名 — 用角色占位(仓管员/客户/系统)

People who liked this also viewed

6 picks

Type

to-brd

24stars2forks

View on GitHub

How to install to-brd?

blueprintos/analysis-to-delivery/to-brd

$npx -y skills add BlueprintOS/analysis-to-delivery --skill to-brd

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# To-BRD — 业务需求文档生成
2
3	## Contract
4
5	- 输入: 已签字的 `TASK_CONFIRM_*.md`、`REVIEW_需求确认书.md`、`REVIEW_字段对齐分析.md`、`paths/knowledge-path.md`
6	- 输出: `01-业务需求文档 BRD.md`、ASCII 流程图、可选 `业务流程图.drawio`
7	- 门控: BRD 必备章节齐全;字段映射与知识库核对;用户签字
8	- Required rules: `stage-gate`, `no-field-guessing`, `ascii-flowchart`, `doc-numbering`, `goal-boundary`
9	- Required paths: `knowledge-path`, `doc-naming-path`
10	- 下一步: `/compliance-review`
11
12	## 适用场景
13
14	- TASK_CONFIRM 和字段对齐分析已通过
15	- 需要把业务需求整理成 BRD 交给团队评审
16	- 需要画业务流程图 / 状态流转图
17
18	## 流程步骤
19
20	### 1. 加载模板
21
22	- `templates/BRD.md`(9 节必备章节)
23
24	### 2. 填充内容
25
26	按 BRD 模板逐节生成:
27
28	\| 章节 \| 内容来源 \|
29	\|---\|---\|
30	\| 一、项目概述 \| TASK_CONFIRM §1-3 \|
31	\| 二、角色与职责 \| 业务调研 \|
32	\| 三、业务流程 \| ASCII 流程图 / drawio \|
33	\| 四、功能模块 \| TASK_CONFIRM §功能描述 \|
34	\| 五、数据要求 \| 字段对齐分析 + 知识库 \|
35	\| 六、合规要点 \| 预留,阶段 4 填 \|
36	\| 七、非功能需求 \| 性能/可靠性/安全/可维护性 \|
37	\| 八、风险与约束 \| 团队约束 + 外部依赖 \|
38	\| 九、上线计划 \| 团队节奏 \|
39
40	### 3. 画流程图
41
42	- 状态流转图:ASCII(参考 `rules/ascii-flowchart.md`)
43	- 业务流程图:简单用 ASCII,复杂用 drawio
44	- 泳道图:ASCII(角色分工清晰)
45
46	### 4. 字段映射表
47
48	把字段对齐分析里的 ✅ 项固化到 BRD §五.3:
49
50	\| 业务概念 \| 字段 \| 备注 \|
51	\|---\|---\|---\|
52	\| ASN 单号 \| `ASN.TC_ASN_ID` \| ❌ 严禁用 ASN_NBR \|
53
54	### 5. DB 验证(如涉及)
55
56	- 仅允许 `SELECT` 查询
57	- 用 `desc table_name` 验证字段定义
58	- 严禁任何 DDL/DML 写操作
59
60	## 输出
61
62	- `01-业务需求文档 BRD.md`
63	- `业务流程图-状态流转.txt`(ASCII)
64	- `业务流程图-收货流程.txt`(如需要,泳道图)
65	- `业务流程图.drawio`(可选,用于可视化)
66
67	## 调用的 rule
68
69	- `rules/ascii-flowchart` — 流程图规范
70	- `rules/no-field-guessing` — 字段名必须查知识库
71	- `rules/doc-numbering` — 文档编号 01
72
73	## 结束条件
74
75	- [ ] BRD 9 个必备章节齐
76	- [ ] ASCII 流程图 + 状态流转图
77	- [ ] 字段映射表通过 `field-alignment-check.py`
78	- [ ] 用户签字进入阶段 4
79
80	## 反模式
81
82	- ❌ 用 Mermaid 写流程图 — 必须 ASCII(参考 rules/ascii-flowchart.md);可视化交付经 `flow-to-mermaid.py --ascii-strict`
83	- ❌ 泳道图回流箭头散乱 — 必须汇聚到同一目标节点(回流闭环强制)
84	- ❌ 字段映射表缺知识库来源 — 每条字段必须标"WMOS 知识库/XX 章"或"项目侧 schema"
85	- ❌ 9 章节缺一 — `brd-check.py --strict` 必须 exit 0
86	- ❌ 写完不跑 `field-alignment-check.py` — 应在签字前自动跑一遍,errors=0 才签字
87	- ❌ 流程图用真实人名/客户名 — 用角色占位(仓管员/客户/系统)

People who liked this also viewed

6 picks

Type