Markdown转流程图
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_6df795bb/markdown-to-flowchart。
技能介绍
具体问题
在技术文档编写中,经常需要描述流程、步骤或决策逻辑。纯 Markdown 文本虽然结构化,但在表达复杂流程时存在不足:
- 文本描述冗长,读者需要逐行解析逻辑
- 分支、循环或并行关系难以直观呈现
- 团队协作时,不同成员对流程理解可能不一致
技能如何工作
该技能通过自动化分析 Markdown 文档,将其转换为 Mermaid 流程图,核心流程如下:
- 读取文档:接收用户提供的
.md文件内容 - 结构分析:识别文档中的关键元素,包括:
- 章节层级 (H1/H2/H3)
- 步骤顺序(数字编号、步骤词)
- 条件分支(如果/否则、是否)
- 依赖关系(需要、先要)
- 并行流程(同时)
- 生成代码:基于分析结果,自动构建 Mermaid 流程图代码:
- 使用 flowchart TD/LR/BT/RL 定义主流程方向
- 节点采用中文描述,确保可读性
- 条件判断使用菱形节点,清晰区分分支
- 输出结果:将 Mermaid 代码嵌入到新的
.md文件中,直接可用
适用边界与注意点
该技能适用于多种文档类型,但需注意以下限制:
- 输入格式:仅支持标准 Markdown 文档,对非结构化文本效果有限
- 节点长度:建议节点描述不超过 20 字,以保持图表清晰
- 逻辑完整性:依赖文档本身的结构化程度,隐含逻辑可能无法自动识别
- 输出依赖:生成的流程图需要支持 Mermaid 的工具渲染,如 GitHub 或本地 Markdown 查看器
通过将文本流程可视化,该技能帮助开发者快速把握文档逻辑,适用于部署文档、API 文档、运维手册、README、教程、架构设计和项目管理等场景。
使用场景
- 在编写部署文档时,将 Markdown 格式的步骤列表转换为 Mermaid 流程图,以可视化部署流程并确保步骤清晰。
- 当分析 API 文档时,使用技能识别调用逻辑并生成接口调用流程图,帮助开发者快速理解依赖关系。
- 在整理运维手册时,将故障排查步骤转换为流程图,实现问题定位的直观展示,减少排查时间。
- 维护项目 README 时,将模块说明和结构转换为流程图,以图形化方式呈现项目架构和组件关系。
适合人员
- 技术文档编写者:需要将 Markdown 格式的步骤文档自动转换为流程图,以增强文档可读性和团队协作效率。
- DevOps 工程师:在编写部署和运维手册时,使用技能生成可视化流程图,简化复杂流程的解释和培训。
- 教程作者:将教程中的学习路径或操作步骤用流程图表示,帮助读者直观跟踪学习进度和逻辑顺序。
- 项目经理:在管理项目任务时,将 Markdown 任务列表转换为流程图,以便团队成员清晰了解任务流程和依赖关系。