Claude Code 根据代码和帮助编写 README
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/readme/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/readme/`,把核对后的文件保存为 `.claude/skills/readme/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/readme`。
中文摘要
以代码、命令帮助和配置为依据编写项目文档,按范围更新快速开始、配置说明和工作原理。
SKILL.md 中文导读
可复现示例
本地演示工具 list-kit 会按行打印活动名称。用户只要求更新快速开始。实际帮助显示 `list-kit show --format text`,提供的示例输入为叶画展和地图课。工作步骤
- 读取代码、配置和实际帮助,确认用户要求更新的范围。
- 把已证实的命令和输出写入快速开始,回看命令选项及路径。
验收方法
快速开始给出已知示例 `list-kit show --format text`。说明输出两行活动名称,并记录现有帮助未说的安装方式要向作者确认。
GitHub 原文 · 更新日期
适用环境
Claude Code 可读取项目工作区。准备代码与真实命令帮助,示例仅修改快速开始范围。
常见问题
快速开始中的选项该从哪里核对?
把项目代码和实际帮助输出一起核对,用已知选项写最短的可运行示例。写完检查命令、标志和路径能与代码对应。