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

Claude Code documentation-guide for Markdown and Mermaid

Use GridMouse’s Markdown conventions to present an overview first and show workflows and dependencies with Mermaid.

中文

Install in Claude Code

Open GridMouse or a project using the same conventions in Claude Code. Have Markdown content and a Mermaid-capable preview.

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

Example task

Document docs-16 explains export preview from “Choose filter, Preview rows, Export CSV”. The directory layout does not need a flowchart.

What to check

Start the overview with the purpose of export preview and render a Mermaid flowchart in the order [Choose filter, Preview rows, Export CSV]. Put the diagram in a language-marked code fence.

Original SKILL.md on GitHub · Updated

Frequently asked question

Should directory trees and workflows both use Mermaid?

Use Mermaid for flowcharts, sequences, and dependencies. Keep directory trees in ordinary code blocks so actual paths stay readable.