mcpField
M
mermaid-mind-map

mermaid-mind-map

github.com/mblode生产力169124 次安装2 天前更新
代码仓库

关于 mermaid-mind-map

Mermaid Mind Map 会分析素材并生成具有层级结构的 Mermaid mindmap,适用于主题探索、代码库概览、文档总结以及功能规划或调试。

主要功能

  1. 01分析主题、代码库和文档
  2. 02提取主题与关联
  3. 03生成层级式 Mermaid 思维导图
  4. 04检查深度、节点数量和语法

适用场景

  1. 01梳理代码库中的模块与依赖
  2. 02以图示总结文档结构
  3. 03将功能需求或调试现象拆分为分支

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mblode/agent-skills --skill mermaid-mind-map

安装后在 Claude Code 中输入/mermaid-mind-map确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
generation-guidelines.md
mermaid-reference.md
mermaid-syntax.md

详细介绍

Mermaid 思维导图

分析源材料,并生成具有 2-4 层分支层级的 Mermaid mindmap 图表。

参考文件

文件何时阅读
references/mermaid-syntax.md默认:思维导图节点形状、缩进、图标及已知限制
references/generation-guidelines.md默认:节点文本限制、深度控制、源类型策略
references/mermaid-reference.md生成非思维导图 Mermaid 图表,或需要更全面的语法参考时

工作流

复制此清单以跟踪进度:

Mind map progress:
- [ ] Step 1: Determine source type
- [ ] Step 2: Set scope (depth, budget, central concept)
- [ ] Step 3: Extract structure
- [ ] Step 4: Generate Mermaid mind map
- [ ] Step 5: Validate output
- [ ] Step 6: Present to user
第 1 步:确定源类型

确定适用的源类型,并执行对应的探索操作:

  • 主题探索:用户提出一个概念。如果范围或受众不明确,提出一个澄清问题。无需扫描文件。
  • 代码库概览:扫描项目结构。阅读关键配置文件(package.json、pyproject.toml 等)。梳理模块、入口点和依赖项。
  • 文件/文档摘要:阅读目标文件。提取关键主题、章节和概念之间的关系。
  • 功能规划/调试:收集需求或症状。拆解为组件、阶段或可能的原因。
第 2 步:设定范围

使用 references/generation-guidelines.md 中的表格选择深度级别(概览、标准或详细)。仅在不明确时询问用户。默认选择标准(3 层,15-30 个节点)。

设定中心概念:用一个清晰的名词或简短短语(1-3 个词)作为根节点。节点总数上限:40 个。

第 3 步:提取结构
  • 从源材料中识别 3-7 个主要分支(理想数量为 5 个)。
  • 根据深度设置,为每个分支识别 2-5 个子节点。
  • 将相关概念归入同一分支。
  • 每个节点必须是单个关键词或简短短语,不能是句子。
  • 有关节点文本的词数限制和关键词提取技巧,请参阅 references/generation-guidelines.md。
第 4 步:生成 Mermaid 思维导图

加载 references/mermaid-syntax.md 以获取准确语法。在带围栏的 mermaid 代码块中生成。

有意选择节点形状(完整的形状策略请参阅 references/generation-guidelines.md):

  • 根节点:中心概念使用 ((circle))
  • 主要分支:类别使用 [square],流程使用 (rounded)
  • 叶节点:一般条目使用默认形状,不确定的条目使用 {cloud}
第 5 步:验证

输出前运行以下检查。如果任何一项未通过,请修改并重新检查:

  • 节点总数(包括根节点)不超过 40 个
  • 最大深度不超过所选级别
  • 节点文本不超过 6 个词
  • 根节点文本为 1-3 个词
  • 每个主要分支有 2-7 个子节点
  • 不存在仅有一个子节点的分支(如有则向上合并)
  • 纯文本节点中没有未转义的 ()[]{}(否则会导致 Mermaid 解析失败)
  • 各分支深度均衡(相差不超过 1 层)
第 6 步:呈现输出

在带围栏的 mermaid 代码块中输出思维导图:

```mermaid
mindmap
  root((Central Concept))
    [Branch 1]
      Sub-topic A
      Sub-topic B
    [Branch 2]
      Sub-topic C
      (Process D)
```

注明可渲染的位置:GitHub Markdown、Mermaid Live Editor、带 Mermaid 扩展的 VS Code。

如果用户要求提供文件,请将带围栏的代码块写入 .md 文件。

反面模式

  • 将句子作为节点标签(应拆分为父级概念和子级详情)
  • 深度超过 4 层(Mermaid 图表会难以阅读;应拆分为多个图表)
  • 节点超过 40 个(应拆分为多个聚焦的图表)
  • 除非用户要求,否则不要添加图标(需要 Font Awesome,且可能无法渲染)
  • 不要在同一个代码块中混用 mindmap 和其他 Mermaid 图表类型

相关技能

  • presentation-creator:创建与可视化概览相辅相成的幻灯片
  • define-architecture:制定超越可视化映射范围的详细架构决策

评论

支持 Markdown