SuperAPI AI 工具集

mermaid-diagrams

数据与分析

查看项目

更新于 10-15 23:48

技能介绍

用途:在生成的 wiki 页面中嵌入 Mermaid 图表,让流程、生命周期或数据模型更易理解。图表应放在最相关的页面,用 ```mermaid 围栏代码块书写。

主要能力与图表选择:sequenceDiagram 用于跨组件的运行时与请求流程(认证流程、请求生命周期、智能体工具循环);stateDiagram-v2 用于生命周期与状态机(任务状态、连接状态、运行阶段);erDiagram 用于数据模型(实体及关系);flowchart TD 用于分支控制流与决策逻辑。

使用方式:每个图表下方加一行说明其内容的标题。图表须基于已检查的源码,不得虚构参与者、状态、实体或关系。优先覆盖高价值场景:记录请求或运行时流程、调用序列、生命周期或状态机、数据模型的页面都应配图;导航、参考表格或纯配置页面可跳过。宁可少而准,不要每页硬塞。

语法安全:标签内不得出现分号或竖线;不得有未转义的尖括号;flowchart 中含括号等标点的标签需用双引号包裹,如 A["calls foo(bar)"];flowchart 节点 id 不得用裸词 end,也不得以 o 或 x 加短横开头;sequenceDiagram 中带空格或标点的参与者名需用别名,如 participant AS as Auth Service;不得使用 Mermaid 保留字(note、end、loop、alt、opt、par、and、else、activate、deactivate、class、state、click、link)作为参与者名、别名或节点 id;erDiagram 的实体与属性名须为单一标识符式 token,人类可读表述放在关系标签中;标签保持简短,解释放到正文或标题。

更新与限制:源码变更导致图表失准时应与正文同次编辑一并更新;仍准确的图表不要重写,以免产生 diff 噪声。若页面存在以 "openwiki: mermaid parse failed" 开头的 HTML 注释所标记的文本围栏,说明上次运行已降级,需按注释中的解析错误修复语法、恢复 ```mermaid 围栏并删除该注释。OpenWiki 会在运行后校验每个 mermaid 围栏,解析失败者会转为纯文本围栏,属于质量失败。资料未提供具体安装命令或收费信息。