mermaid-diagram-guide

本条目面向做封面图与设计场景,提供“mermaid-diagram-guide”技能的目录入口。公开标签:learning、Mermaid、流程图、时序图。请通过固定上游版本核对实际功能、依赖与权限;此页为 Skillπ 独立编写的用途介绍和原站链接,不代表运行安全保证。原文与附件依各自许可开放。

仓库
brycewang-stanford/Auto-Empirical-Research-Skills
仓库最近推送
Stars
5,023
Forks
578
Issues / PRs
0

安装方式

先用 Prompt 核对来源,也可切换到安装命令或下载可用的安装包。

安装方式

用 AI 助手安装

复制提示词,让助手先核对固定版本和依赖。

查看 Prompt收起 Prompt
先检查当前 Agent 是否已安装 SkillPI Skill Finder。如果尚未安装,请按官方仓库的说明安装并启用:https://github.com/Findskills/skillpi。然后使用 Skill Finder 打开此 SkillPI 详情页并定位 "mermaid-diagram-guide":https://skillpi.com/zh/skills/deepskill-868f4e579fcb3795a8466e2fc9fe403e12442fa48f6da511c58bacd4645ff960。安装前核对上游来源和版本:https://github.com/brycewang-stanford/Auto-Empirical-Research-Skills/blob/bfa0a6e5a843babbf45a1ef1663fd5dc4f07c0ba/skills/43-wentorai-research-plugins/skills/tools/diagram/mermaid-diagram-guide/SKILL.md。来源不一致时停止并说明差异。核对通过后,用 Skill Finder 安装目标 Skill,并报告安装路径和来源版本。

此命令从 GitHub 来源仓库获取指定技能。运行前请先查看源文件。

运行工具
npx skills add https://github.com/brycewang-stanford/Auto-Empirical-Research-Skills/tree/bfa0a6e5a843babbf45a1ef1663fd5dc4f07c0ba/skills/43-wentorai-research-plugins/skills/tools/diagram/mermaid-diagram-guide --skill mermaid-diagram-guide
许可协议: —

来源与配置

查看 GitHub 源码

brycewang-stanford/Auto-Empirical-Research-Skills固定提交 bfa0a6e5a843babbf45a1ef1663fd5dc4f07c0ba

配置方式待核实

请查看原始来源中的适用工具、依赖和权限要求。

安装实测待补充

本条目面向做封面图与设计场景,提供“mermaid-diagram-guide”技能的目录入口。公开标签:learning、Mermaid、流程图、时序图。请通过固定上游版本核对实际功能、依赖与权限;此页为 Skillπ 独立编写的用途介绍和原站链接,不代表运行安全保证。原文与附件依各自许可开放。

↓ 0 下载 ↗ 0 分享点击

文件浏览

在原站浏览文件 ↗

原始 SKILL.md

打开原文 ↗
---
name: mermaid-diagram-guide
description: "Create flowcharts, sequence diagrams, and architecture diagrams with Mermaid"
metadata:
  openclaw:
    emoji: "📋"
    category: "tools"
    subcategory: "diagram"
    keywords: ["flow chart", "architecture diagram", "Mermaid", "UML diagram", "graphical abstract"]
    source: "N/A"
---

# Mermaid Diagram Guide

## Overview

Mermaid is a text-based diagramming tool that renders diagrams from Markdown-like syntax. For researchers, Mermaid offers a unique combination of version-controllable source code, instant rendering in documentation platforms (GitHub, GitLab, Notion, Obsidian), and enough expressiveness to create flowcharts, sequence diagrams, class diagrams, Gantt charts, and more.

Unlike graphical tools like draw.io or Lucidchart, Mermaid diagrams live as plain text in your documentation, making them easy to maintain alongside code and papers. They are especially valuable for research documentation, README files, software architecture diagrams in methods sections, and graphical abstracts.

This guide covers the most useful Mermaid diagram types for academic work, with complete syntax references and real-world examples from research contexts. Each diagram type includes a template you can copy and modify for your specific needs.

## Flowcharts

Flowcharts are the most common diagram type for describing algorithms, experimental procedures, and data processing pipelines.

### Basic Syntax

```mermaid
flowchart TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Process A]
    B -->|No| D[Process B]
    C --> E[End]
    D --> E
```

### Node Shapes

| Shape | Syntax | Use Case |
|-------|--------|----------|
| Rectangle | `A[text]` | Process step |
| Rounded | `A(text)` | Start/end |
| Diamond | `A{text}` | Decision |
| Hexagon | `A{{text}}` | Preparation |
| Parallelogram | `A[/text/]` | Input/output |
| Circle | `A((text))` | Connector |
| Stadium | `A([text])` | Terminal |

### Research Pipeline Example

```mermaid
flowchart TD
    subgraph Data Collection
        A[Raw Data] --> B[Quality Check]
        B --> C{Pass QC?}
        C -->|No| D[Exclude]
        C -->|Yes| E[Clean Data]
    end

    subgraph Analysis
        E --> F[Feature Extraction]
        F --> G[Model Training]
        G --> H[Cross-Validation]
    end

    subgraph Evaluation
        H --> I{Significant?}
        I -->|Yes| J[Report Results]
        I -->|No| K[Revise Hypothesis]
        K --> F
    end

    style A fill:#3B82F6,color:#fff
    style J fill:#16A34A,color:#fff
    style D fill:#EF4444,color:#fff
```

### Direction Options

| Direction | Code | Description |
|-----------|------|-------------|
| Top to bottom | `TD` or `TB` | Default, vertical |
| Bottom to top | `BT` | Vertical, upward |
| Left to right | `LR` | Horizontal |
| Right to left | `RL` | Horizontal, reversed |

## Sequence Diagrams

Sequence diagrams show interactions between components over time. They are ideal for describing API calls, protocol steps, and system interactions.

```mermaid
sequenceDiagram
    participant U as User
    participant F as Frontend
    participant A as API Server
    participant DB as Database

    U->>F: Submit experiment
    F->>A: POST /experiments
    A->>DB: INSERT experiment
    DB-->>A: experiment_id
    A->>A: Queue processing job

    Note over A: Async processing begins

    A-->>F: 202 Accepted {id}
    F-->>U: "Experiment submitted"

    loop Every 5 seconds
        F->>A: GET /experiments/{id}/status
        A-->>F: {status: "running"}
    end

    A-->>F: {status: "complete", results: {...}}
    F-->>U: Display results
```

### Arrow Types

| Arrow | Syntax | Meaning |
|-------|--------|---------|
| Solid with arrowhead | `->>` | Synchronous call |
| Dotted with arrowhead | `-->>` | Response/return |
| Solid | `->` | Message |
| Dotted | `-->` | Optional message |
| Cross | `-x` | Failed message |

## Class Diagrams

Class diagrams document code architecture and data models:

```mermaid
classDiagram
    class Experiment {
        +String id
        +String name
        +DateTime created_at
        +Status status
        +run()
        +get_results() Results
    }

    class Dataset {
        +String path
        +int n_samples
        +int n_features
        +load() DataFrame
        +split(ratio) TrainTest
    }

    class Model {
        +String architecture
        +Dict hyperparams
        +train(Dataset)
        +predict(Dataset) Array
        +evaluate(Dataset) Metrics
    }

    Experiment "1" --> "1..*" Dataset : uses
    Experiment "1" --> "1..*" Model : trains
    Model ..> Dataset : depends on
```

## Gantt Charts

Gantt charts are useful for project timelines and research plans:

```mermaid
gantt
    title Research Project Timeline
    dateFormat YYYY-MM-DD
    axisFormat %b %Y

    section Literature Review
        Survey existing work     :done, lit1, 2026-01-01, 30d
        Identify research gap    :done, lit2, after lit1, 14d

    section Methodology
        Design experiments       :active, meth1, after lit2, 21d
        Implement baseline       :meth2, after meth1, 14d

    section Experiments
        Run baseline experiments :exp1, after meth2, 21d
        Run proposed method      :exp2, after exp1, 21d
        Ablation studies         :exp3, after exp2, 14d

    section Writing
        Draft paper              :write1, after exp2, 30d
        Internal review          :write2, after write1, 14d
        Submit to conference     :milestone, after write2, 0d
```

## State Diagrams

State diagrams model entity lifecycles:

```mermaid
stateDiagram-v2
    [*] --> Draft
    Draft --> UnderReview : Submit
    UnderReview --> MinorRevision : Reviewer feedback
    UnderReview --> MajorRevision : Reviewer feedback
    UnderReview --> Rejected : Reviewer feedback
    MinorRevision --> UnderReview : Resubmit
    MajorRevision --> UnderReview : Resubmit
    UnderReview --> Accepted : Final decision
    Accepted --> Published : Camera-ready
    Rejected --> Draft : Revise for new venue
    Published --> [*]
```

## Rendering and Integration

### GitHub / GitLab

Both platforms render Mermaid natively in Markdown files:

````markdown
```mermaid
flowchart LR
    A --> B --> C
```
````

### Command-Line Rendering

```bash
# Install Mermaid CLI
npm install -g @mermaid-js/mermaid-cli

# Render to PNG
mmdc -i diagram.mmd -o diagram.png -w 1200

# Render to SVG (preferred for papers)
mmdc -i diagram.mmd -o diagram.svg

# Render to PDF
mmdc -i diagram.mmd -o diagram.pdf
```

### Embedding in LaTeX

```latex
% Include the SVG generated by mmdc
\usepackage{svg}
\begin{figure}[h]
  \centering
  \includesvg[width=0.8\textwidth]{diagram}
  \caption{System architecture overview.}
\end{figure}
```

## Best Practices

- **Keep diagrams focused.** One concept per diagram. If it exceeds 15-20 nodes, split it.
- **Use subgraphs for grouping.** They clarify which components belong together.
- **Label all edges.** Unlabeled arrows are ambiguous.
- **Use consistent styling.** Define colors for success (green), failure (red), and process (blue) states.
- **Export as SVG for papers.** SVG scales perfectly and produces crisp output at any size.
- **Version-control your diagrams.** Since Mermaid is text, it diffs cleanly in Git.
- **Test in the live editor.** Use [mermaid.live](https://mermaid.live/) to iterate quickly before committing.

## References

- [Mermaid Documentation](https://mermaid.js.org/) -- Official reference
- [Mermaid Live Editor](https://mermaid.live/) -- Interactive diagram editor
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) -- Command-line rendering tool
- [GitHub Mermaid Support](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) -- Native rendering in GitHub

版本历史

  1. v2026.07 GitHub ↗
    原版更新说明

    ## Highlights - **First tagged release.** Every gate is green: `make check` (validate + 183 unit tests + eval-harness + numeric benchmarks), validate-catalog, quality-evals, and OpenSSF Scorecard on `main`. - **Rigor double loop at 13 method families.** Each family closes taxonomy tag → eval scenario (does the agent avoid the method's known traps?) → deterministic numeric benchmark (does it recover the true effect?). New this cycle: heterogeneous treatment effects (CATE) and quantile treatment effects (QTE). - **Paper-WorkFlow flagship at 29/29 executable rigor gates**, now merged to its `main` with a drift-gated README badge — the credibility artifact is checked by CI, so it can never silently go stale ([RIGOR.md](https://github.com/brycewang-stanford/Paper-WorkFlow/blob/main/RIGOR.md)). - **1,150 vendored skills / 69 collections**, all license-audited, security-scanned, tracked in a machine-readable catalog with CI-enforced freshness, and importable as a single whole-repo router skill. - **Hardened weekly upstream syncs**: synced trees must pass the full gate before merge; this cycle both sync PRs were verified, patched (StatsPAI's SkillOpt execution-gate card restored), and merged. - **First-party plugin marketplace** (Python / R / Stata empirical-analysis plugins + guide) shipped in the previous cycle, now under a tagged version. ## Known Follow-Ups - Ecosystem benchmark comparison (AERS vs econometrics agents on the shared benchmark suite) — [PLAN-2026-07 week 3](https://github.com/brycewang-stanford/Auto-Empirical-Research-Skills/blob/main/docs/PLAN-2026-07.md). - Decomposition (Oaxaca–Blinder) and shift-share (Bartik) method families (weeks 3–4). - GitHub Pages catalog site, README demo screenshots, five-language README consistency script (week 4). ## Catalog - Top-level collections: **69** - `SKILL.md` files: **1150** - Cataloged agent tools: **335** ([`tools/CATALOG.md`](../tools/CATALOG.md)) ## Methodological rigor - Method families in the coverage map: **13** ([`RIGOR_COVERAGE.md`](RIGOR_COVERAGE.md)) - Eval scenarios: **26** (138 rubric items, 122 auto-checkable) ([`../eval-harness/`](../eval-harness/README.md)) - Benchmark tasks: **13** (70 gold checks, 58 required) ([`../benchmark/`](../benchmark/README.md)) ### Method families (skills tagged) - `iv`: 27 - `rdd`: 25 - `panel-fe`: 19 - `staggered-did`: 17 - `bayesian`: 13 - `did`: 10 - `event-study`: 10 - `matching`: 10 - `synthetic-control`: 10 - `cate`: 8 - `dml`: 8 - `survival`: 3 - `quantile`: 2 ### Eval scenarios by category - `causal-identification`: 14 - `citation-hygiene`: 1 - `reproducibility`: 2 - `research-integrity`: 1 - `runtime-safety`: 1 - `statistical-validity`: 2 - `writing-compliance`: 3 - `writing-style`: 2 ## License buckets - AGPL-3.0: 1 - Apache-2.0: 1 - CC-BY-NC-4.0 (non-commercial): 1 - CC-BY-SA-4.0: 1 - CC-BY-SA-4.0 (repository default): 4 - GPL-3.0: 1 - MIT: 35 - MIT Non-Commercial: 1 - Mixed (per-skill; see folder): 2 - UNKNOWN - check upstream: 22 ## Quality gates - `make check` — catalog/provenance/audit/eval freshness, repo hygiene, Paper-WorkFlow gates, stdlib unit tests, eval-harness lint + graded smoke, and the strict numeric benchmark (reference-gold drift fails the build). - External links and OpenSSF Scorecard run on their scheduled workflows.

当前收录版本

0.0.1

核对来源版本 ↗

质量评测

满分 100。前四项来自 DeepSkill 收录的质量报告。

场景价值95/100
评分依据

提供 Mermaid 图表创建指南,适用于研究人员和开发者,解决文档可视化的核心痛点

触发精准90/100
评分依据

触发词精准完整,覆盖多种变体,边界清晰

结构规范90/100
评分依据

Phase/步骤清晰,有出口条件,含端到端示例

执行可靠90/100
评分依据

工具来源明确,参数正确,覆盖主要异常

证据可验 (前四项均值)91/100
计算方式

取前四项原始分值的算术平均,四舍五入取整。可通过收录报告核对各项评分与说明,运行记录需单独查证。

权限与使用前检查

根据当前主文档自动整理,命中内容可能是示例或防护说明;不是实际权限声明,也未覆盖附件、外部依赖或运行行为。

  • 安装或获取外部依赖

    使用官方来源并锁定版本,在隔离环境检查安装脚本。当前文档检查不覆盖后续下载的代码。

    主文档提及 · 第 230 行
文档引用的域名或地址

这些地址可能用于文档链接或示例,不是已批准的联网清单。使用前核对实际目的地及发送的数据。

  • github.blog
  • github.com
  • mermaid.js.org
  • mermaid.live

本站展示提示不会授予权限。涉及文件改动、密钥、外部发送或费用时,仍由你使用的工具按需确认。

安全评级与访问范围

risk · 静态证据核验,不代表运行安全保证。

使用前请由宿主核对并授权实际文件读写、外部服务和联网目的地;本站的核验不会授予任何运行权限。

来源与使用声明 SkillPi 的部分技能资料来自公开来源或创作者提交。第三方内容的权利归各自权利人所有。安装或运行前,请查看原站的许可、权限要求和使用风险。

来源与使用

请按详情页的作者、原始来源和许可证核对使用条件,运行前检查技能需要的权限。目录收录不等于已验证安装或安全性。