词映 AI导航
工具库Skills 技能
我的收藏
词映 AI导航

Document a Markdown flowchart in Claude Code

Use Mermaid for project documentation diagrams such as flows, sequences, entity relationships, and states.

中文

Install in Claude Code

A Claude Code project and a Markdown renderer that can display Mermaid. Bring the actual steps or relationships to document.

  1. Review `.claude/skills/documentation/SKILL.md` and its requirements at the pinned GitHub commit.
  2. Create `.claude/skills/documentation/` in your project and save the reviewed file as `.claude/skills/documentation/SKILL.md`.
  3. Start Claude Code from that project's root, then select `/documentation` in the slash menu.

Example task

Document the sequence for library event registration. The given data is `Register -> Review -> Confirm`. The editor needs a README flowchart that retains the order of all steps.

What to check

Use Mermaid flowchart LR with three nodes and edges `Register --> Review --> Confirm`. Name the diagram so readers recognize it as registration approval.

Original SKILL.md on GitHub · Updated

Frequently asked question

What diagram should a README use for the registration flow?

Use a flowchart for a sequence of steps and a sequence diagram for messages between participants. Confirm the order and preview the Mermaid output.