mcpField
C
charts-flow

charts-flow

github.com/vladm3105文档处理17109 次安装1 天前更新
代码仓库

关于 charts-flow

charts-flow 是用于在 SDD 文档中创建和维护 Mermaid 架构图的技能。它将图表保存为带双向引用的独立文件,并提供语法验证和 SVG 预览。

主要功能

  1. 01创建带引用的 Mermaid 图表文件
  2. 02将内嵌图表迁移为独立文件
  3. 03验证语法并生成 SVG 预览
  4. 04支持六种架构图类型

适用场景

  1. 01为 SDD 文档添加架构图
  2. 02将复杂的内嵌图表迁移到文件
  3. 03在多份文档间复用图表

安装

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

$npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill charts-flow

安装后在 Claude Code 中输入/charts-flow确认已加载。

详细介绍

charts-flow

用途

为 SDD 文档生成并维护 Mermaid 架构图。图表存放在与父文档相邻的独立 diagrams/ 文件中,避免父文档因渲染而变得臃肿,并通过稳定的图表 ID 和回链保持与父文档的可追溯性。

这是该插件唯一的图表技能:所有 Mermaid 图表生成、验证和 SVG 渲染都在此完成。

使用场景

在以下情况下使用 charts-flow:

  • 为 BRD、PRD、ADR、SPEC 或 IPLAN 添加架构图(流程图、时序图、类图、状态图、组件图或部署图)。
  • 将现有的内嵌 mermaid 代码块迁移到独立的图表文件中。
  • 父文档因复杂的内嵌图表而渲染缓慢,或需要在多个文档中复用图表。

请勿将其用于简单表格/列表(请使用 markdown)、可正常内嵌渲染的小型图表,或不属于 SDD 图表规范的非架构图表(甘特图、饼图)。

行为

创建新图表

  1. 根据文件名确定父文档 ID(例如 PRD-01),并找到其文件夹。
  2. 如果不存在,则在父文档旁创建 diagrams/,并编写 {PARENT-ID}-diag_{description}.md,其中包含文档控制块(父文档链接、图表类型、日期)、概述、mermaid 代码块以及指回父文档的参考资料部分。
  3. 渲染 SVG(如果可用则使用 mmdc CLI,否则使用 Mermaid Live),验证语法,并在父文档中通过可折叠的 <details> 块嵌入 SVG 预览,同时链接到图表文件。

迁移内嵌图表

  • 扫描父文档中的 mermaid 代码块,将每个代码块移入独立的图表文件(多个图表时编号),然后用 SVG 预览和参考链接替换原代码块,同时保持文档流程。

支持的类型:流程图/图表、时序图、类图、状态图、组件图和部署图。每个图表文件都遵循相同的文档控制 + 参考资料结构,以确保双向交叉引用均可解析。

图表规范(按层):图表归属于拥有可视化模型的层——BRD(C4 L1 + DFD L1)、PRD(C4 L2 + DFD L2 + 关键时序图)、ADR(决策时序图)、SPEC(C4 L3 + DFD L3)。使用该层模板规定的 @diagram: 标签,并遵循 ${CLAUDE_PLUGIN_ROOT}/framework/governance/DIAGRAM_STANDARDS.md。

质量门槛:图表文件位于正确的 diagrams/ 文件夹中;名称符合 {PARENT-ID}-diag_{description}.md;文档控制块包含指向父文档的回链;Mermaid 语法有效;已嵌入 SVG;所有交叉引用均可解析;SVG < 1 MB。

相关资源

  • 图表标准:${CLAUDE_PLUGIN_ROOT}/framework/governance/DIAGRAM_STANDARDS.md
  • ID 和标签标准:${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  • 负责图表的层模板: ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml、 ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/PRD-TEMPLATE.yaml、 ${CLAUDE_PLUGIN_ROOT}/framework/layers/05_ADR/ADR-TEMPLATE.yaml、 ${CLAUDE_PLUGIN_ROOT}/framework/layers/06_SPEC/SPEC-TEMPLATE.yaml
  • 路线图可视化:../adr-roadmap/SKILL.md
  • Mermaid:https://mermaid.js.org/ · https://mermaid.live

评论

支持 Markdown