Claude Code 编排项目 README 导览
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/readme-style/SKILL.md`，核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/readme-style/`，把核对后的文件保存为 `.claude/skills/readme-style/SKILL.md`。
- 在该项目根目录启动 Claude Code，在斜杠菜单中选择 `/readme-style`。
中文摘要
在项目 README 前部放系统概览、快速入口和流程图，按已核实的代码和文档说明能力。
SKILL.md 中文导读
可复现示例
虚构站点的模块关系为 `[Schedule, Print adapter, Preview]`。已确认页面能预览排练表，邮件通知仍是规划，README 需要交代两种状态。工作步骤
- 核对真实模块与主流程，在前部安排概览、快速入口和 Mermaid 图。
- 把详细内容链接到专业说明，在准确性备注中区分已实现与规划。
验收方法
概览后加入 Mermaid 流程 `Schedule --> Adapter[Print adapter] --> Preview` 所对应的三个节点。快速入口指向已存在的使用文档，准确性备注写明邮件通知仍在规划。
GitHub 原文 · 更新日期
适用环境
Claude Code 与包含源码和专业文档的项目。沿用 ambrouse 项目的 README 结构约定。该项目 README 采用带声调的越南语。
常见问题
README 怎样用流程图解释已存在的主要流程？
先从源码核实模块边界和调用关系，再把已实现的步骤连成流程。让详细说明留在专门文档，并标清尚未实现的能力。