跳到主要内容

Mermaid 图示写作规范

状态:Active / 站点级图示写作约束

什么时候使用 Mermaid

公开给人阅读的当前事实源、战略白皮书、产品定义、治理协议和 playbook 中,如果内容表达的是链路、推导顺序、状态转换、系统关系或时序交互,应优先使用 Mermaid,而不是把图示写成 text 代码块。

以下情况保留 text 代码块:

  • 目录树、命令输出、日志、prompt 模板、schema 片段;
  • 需要保留原始证据形态的评测材料、run log、reference 原文摘录;
  • 不发布为当前事实源的历史归档材料。

推荐图型

内容类型推荐 Mermaid 图型
生态主链、能力链路、文档推导顺序flowchart LR / flowchart TD
项目定位、上下游关系、状态转换flowchart LR / flowchart TD
消费者、资产、能力分类mindmap
多角色交互、接口调用、反馈回流sequenceDiagram

写作规则

  1. Mermaid 图只增强可读性,不替代正文定义。
  2. 图前应有一句说明图的解释范围,尤其要说明是否代表第一阶段必须集成。
  3. 节点标签使用中文可读名称;需要英文对象名时保留正式项目名。
  4. 复杂节点使用 <br/> 换行,避免过长单行。
  5. 不把工程文件名、私有路径、运行日志或 prompt 原文改写成 Mermaid 图。
  6. 不为归档证据追求图形化,避免改变历史材料的证据形态。

基础模板

生态主链:

文档推导顺序: