Claude Code documentation-guide:用概要和 Mermaid 组织项目文档
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/documentation-guide/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/documentation-guide/`,把核对后的文件保存为 `.claude/skills/documentation-guide/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/documentation-guide`。
中文摘要
按 GridMouse 的 Markdown 约定组织仓库文档,在开头交代概要,并用 Mermaid 呈现流程和依赖。
SKILL.md 中文导读
可复现示例
文档 docs-16 解释导出预览,步骤输入为“Choose filter, Preview rows, Export CSV”。目录结构无需画成流程图。工作步骤
- 先写文档概要,标出读者需要知道的流程和文件位置。
- 把流程和依赖写成 Mermaid 图,核对相对链接和代码块格式。
验收方法
概要先说明导出预览的作用,Mermaid 流程图按 [Choose filter, Preview rows, Export CSV] 排列。用带语言标识的代码块渲染流程。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开 GridMouse 或采用这套约定的项目,准备 Markdown 和支持 Mermaid 的预览环境。
常见问题
目录树和步骤流程都需要用 Mermaid 吗?
流程、时序和依赖图用 Mermaid。目录树继续使用普通代码块,便于查看实际路径。