SuperAPI AI 工具集

charts-flow

设计与创作

查看项目

更新于 10-16 01:06

技能介绍

用途:为 SDD 文档生成并维护 Mermaid 架构图。图存放在父文档旁的 diagrams/ 目录,独立成文件以让父文档保持精简并加快渲染,同时通过稳定图表 ID 和反向链接保持可追溯。这是该插件唯一的图表技能,所有 Mermaid 生成、校验与 SVG 渲染都在此完成。

主要能力:新增架构图(flowchart、sequence、class、state、component、deployment)到 BRD、PRD、ADR、SPEC 或 IPLAN;将已有内联 mermaid 块迁移为独立图表文件;解决父文档因复杂内联图渲染慢或图需跨文档复用的问题。新建流程为:从文件名推导父文档 ID(如 PRD-01)并定位其文件夹;在父文档旁创建 diagrams/(若不存在),写入 {PARENT-ID}-diag_{description}.md,包含 Document Control 块(父链接、图表类型、日期)、概述、mermaid 块及指回父文档的 References 节;用 mmdc CLI(若可用,否则 Mermaid Live)渲染 SVG、校验语法,并在父文档中以可折叠 <details> 块嵌入 SVG 预览并附图表文件链接。迁移流程:扫描父文档中的 mermaid 块,逐个移入独立图表文件(多个则编号),用 SVG 预览加引用链接替换原块,保持文档流。各层图表契约:BRD 用 C4 L1 + DFD L1,PRD 用 C4 L2 + DFD L2 + 关键时序,ADR 用决策时序,SPEC 用 C4 L3 + DFD L3;使用各层模板指定的 @diagram: 标签并遵循治理文件规范。

适用场景:为 SDD 文档新增或迁移架构图、父文档渲染慢、图需跨文档复用。

限制:不适用于简单表格或列表(用 markdown)、内联渲染良好的微型图、以及不属于 SDD 图表契约的非架构图(如 Gantt、饼图)。质量门禁:图表文件须位于正确的 diagrams/ 目录,命名匹配 {PARENT-ID}-diag_{description}.md,含带父反向链接的 Document Control,Mermaid 语法有效,SVG 已嵌入,所有交叉引用可解析,且 SVG 小于 1 MB。