Flow Brief

这是什么？适合谁？

Flow Brief（shaokeyibb/flow-brief）是一个把系统/模块/未建功能转成单文件 HTML 泳道图简报的 Agent Skill：带出处徽章、面向团队外读者。

核心价值：把架构沟通自动化——把系统、模块甚至还没建的功能，转成单文件 HTML 泳道图简报，带出处徽章，让非技术读者也能看懂。

适合人群：

• 需要向非技术方讲清系统架构的人
• 做架构文档的工程师
• 想快速产出泳道图简报的 PM/设计

使用前提：一个编码 Agent；要梳理的系统/模块信息。

准备工作

1. Agent 环境：Skill 面向编码 Agent。
2. 系统信息：准备要梳理的系统/模块描述。
3. 安装：作为 Skill 安装。
4. 成本：MIT 开源免费；Agent 调用按模型计费。
5. 时间预算：安装 + 第一份简报约 15 分钟。

快速上手（3 步）

第一步：安装 Skill

git clone https://github.com/shaokeyibb/flow-brief ~/.claude/skills/flow-brief

第二步：描述系统/模块

把系统、模块或未建功能描述给它。

第三步：生成简报

生成单文件 HTML 泳道图简报。

成功判定：从系统描述生成一份带出处徽章、面向非技术读者的 HTML 泳道图简报。

初级用法

泳道图

用泳道图表达流程与模块关系。

单文件 HTML

产出即开即用的单文件简报。

出处徽章

给信息带出处，增强可信度。

高级玩法

未建功能规划

为尚未实现的功能画流程蓝图。

多层级梳理

从系统到模块逐层展开。

风格定制

调整简报的视觉风格。

小技巧

1. 信息先梳理清：垃圾进垃圾出。
2. 面向读者表达：非技术读者要少术语。
3. 出处要真实：徽章指向可查来源。
4. 单文件便于分享：适合邮件/群发。
5. 适度美化：清晰比花哨重要。

常见踩坑

踩坑 1：信息失真

• 现象：泳道图与真实系统不符。
• 原因：描述不准确或 Agent 理解偏差。
• 解决：生成后与真实系统核对。

踩坑 2：术语过重

• 现象：非技术读者看不懂。
• 原因：没有做读者视角转换。
• 解决：要求用通俗语言表达。

踩坑 3：出处错误

• 现象：徽章指向不存在的来源。
• 原因：出处信息未经核实。
• 解决：逐条核对出处链接。

踩坑 4：图太复杂

• 现象：泳道图信息过载。
• 原因：一次性塞进太多内容。
• 解决：分层展示，先总后分。

踩坑 5：项目较新

• 现象：功能有限。
• 原因：项目 2026-08 创建。
• 解决：以 README 为准。

常见问题 FAQ

Q1: 什么是泳道图？

A: 按角色/模块分行展示流程与职责的图，常用于架构沟通。

Q2: 产出是什么格式？

A: 单文件 HTML，即开即用。

Q3: 免费吗？

A: MIT 开源免费；Agent 调用按模型计费。

Q4: 能给未建功能画图吗？

A: 可以，这是它的特色之一。

Q5: 适合给谁看？

A: 面向团队外读者，适合向非技术方简报。

进阶学习建议

掌握基础后，建议深入：

1. 把架构简报模板化，沉淀团队的沟通范式。
2. 用泳道图梳理核心业务流程，发现瓶颈。
3. 为未建功能画蓝图，辅助产品规划沟通。

参考链接

• 官方仓库

最后更新：2026-08-29 · 作者：MagicNetWorld · 基于公开资料整理，关键数据经 GitHub API 独立实测核验，AI 辅助生成