Claude Code Markdown 流程图文档
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/documentation/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/documentation/`,把核对后的文件保存为 `.claude/skills/documentation/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/documentation`。
中文摘要
在 README 或架构说明中用 Mermaid 表达流程、交互、实体关系和状态变更。
SKILL.md 中文导读
可复现示例
要记录图书馆活动报名的顺序。数据是 `Register -> Review -> Confirm`。编辑需要在项目 README 中用流程图解释三个步骤,保留实际顺序。工作步骤
- 整理报名流程的节点及顺序,在 README 中选择 Mermaid 流程图。
- 核对每条连接所表示的实际顺序,并查看预览。
验收方法
用 Mermaid 的 flowchart LR 表达三个节点,连线为 `Register --> Review --> Confirm`。标题交代这是报名审批流程。
GitHub 原文 · 更新日期
适用环境
Claude Code 与支持 Mermaid 预览的 Markdown 阅读环境。准备要说明的节点及其关系。
常见问题
README 里怎样表达报名流程?
顺序步骤可以用流程图,参与者之间的消息则用时序图。先核对步骤次序,再预览 Mermaid 渲染。