关于 update-readme
Update README 是用于同步英文和简体中文项目 README 的技能,要求内容符合仓库当前状态。它指导检查项目文件、撰写双语文档,并在写入前核对准确性与一致性。
主要功能
- 01检查项目组件和现有文档
- 02采用一致的 README 结构
- 03撰写英文和中文版本
- 04核验组件列表与命令
- 05检查两个文件的一致性
适用场景
- 01项目变更后更新文档
- 02保持双语 README 内容一致
- 03根据仓库内容核对组件列表
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ fradser/ dotclaude --skill update-readme安装后在 Claude Code 中输入/update-readme确认已加载。
附带文件references/template.md
详细介绍
更新 README
确保 README.md(英文,主版本)和 README.zh-CN.md(简体中文,次版本)与项目当前的实际状态保持同步。两个文件都必须准确、完整且相互一致。
重要:事实依据与标题格式
- 依据实际情况撰写,不要凭记忆或假设。README 中列出的每项技能/组件在撰写时都必须确实存在于仓库中。撰写前请核实。
- 每份 README 都必须以“标题格式”部分所示的确切结构开头,包括语言切换链接。根据项目调整徽章、项目名称和描述;不得省略该结构。
- 不要在对话中将 README 内容作为代码块输出。请使用 Edit 或 Write 工具直接写入文件。
标题格式(必需)
每份 README 都必须以以下确切结构开头——根据项目调整徽章、项目名称和描述:
# <Project Name> 
[](<link>) [](<link>)
**English** | [简体中文](README.zh-CN.md)
对于 README.zh-CN.md,请反转语言切换链接:
# <Project Name> 
[](<link>) [](<link>)
[English](README.md) | **简体中文**
选择能真实反映项目情况的徽章。常见类型包括:CI 状态、许可证、语言/运行时版本、软件包注册表版本、代码覆盖率。没有实时数据接口时,请使用 shields.io 静态徽章。徽章行超过两个徽章时,优先使用引用式 Markdown 链接,这样源码更易读。徽章失效或总是显示失败,比不加徽章更糟;只添加有人维护的徽章。
流程
1. 调查项目
动笔前,请检查项目的实际状态:
- 扫描所有技能/模块目录及其 SKILL.md 或等效说明文件
- 记录每个组件的名称、一句话用途、安装方法和显著的前置条件
- 检查 git log,了解近期新增或移除的内容
- 阅读现有 README 文件,了解已有内容以及哪些内容已经过时
依据实际情况撰写,不要凭记忆或假设。
2. 起草 README.md(英文)
以 references/template.md 作为结构起点。根据项目领域调整各部分的名称——模板提供的是框架,而非具体文案。
章节顺序(不适用的章节可省略,不要为了凑数而添加章节):
- 标题——标题、徽章和语言切换链接
- 一句话简介
- Logo、横幅或演示 GIF——可选;如果项目有,请尽早放置
- 主要内容章节(可用项、用法等)
- 贡献/添加新项目
- 许可证
README 超过约 300 行时,请在一句话简介之后添加目录。
README 是目录,不是教程。每个组件的说明控制在一到两句话。安装命令必须可直接复制粘贴——命令要精确,不得含糊。始终使用带语言标记的围栏代码块(```bash、```json)。
文字应自然易读。README 文案很容易充斥常见的 AI 写作套路——不知不觉就会堆积“强大”“健壮”等词语、每条都以粗体开头的项目符号,以及“充当……”之类的表述。请特别注意以下几点:
- 选词:避免使用“利用”“简化流程”“健壮”“运用”“深入探讨”。直接说清楚即可。
- 项目符号:不要让每一项都以粗体短语开头。那样读起来像 AI 生成的文档。
- 描述:说明组件的功能,不要说它“充当”或“作为”什么。
- 营销语气:“强大”“无缝”“全面”毫无助益。删掉这些词。
- 填充过渡语:“值得注意的是”“重要的是”“尤其值得一提的是”——删掉这些表达。
一个实用的检验方法:大声读出每句话。如果听起来像宣传文案,就改写成平实的事实陈述。
3. 起草 README.zh-CN.md(中文)
忠实翻译英文 README。规则:
- 使用自然的简体中文——不要翻译普遍使用英文的技术术语(CLI 工具名称、包管理器命令、GitHub URL、代码块)。
- 保持所有代码块、命令和文件路径与英文版本完全一致。
- 章节标题应使用地道的中文(例如“可用技能”“添加新技能”),不要逐字翻译。
- 语言切换链接必须是
[English](README.md) | **简体中文**。 - 遵循与英文版本相同的朴实易懂原则。中文技术写作也有 AI 腔调——能用简单词语时就不要用夸张说法。
4. 写入前检查
写入任一文件前,请确认:
- 列出的每项技能或组件目前都确实存在于仓库中
- 安装命令可以直接复制粘贴,且准确无误
- 没有章节描述已移除的内容
- 两个文件涵盖相同内容,顺序也相同
然后检查草稿中的表达问题:
- 破折号总共是否超过 2–3 处?删掉大部分。
- 是否有句子以“The X serves as...”开头?改写为“The X is...”。
- 是否处处都采用先加粗再列点的格式?去掉加粗。
- 是否在多个描述中反复使用同一个词语或比喻?换一种表达。
- 是否使用了 Unicode 箭头(→)?改用普通文字。
5. 写入文件
先写入 README.md,再写入 README.zh-CN.md。使用 Edit 或 Write 工具——不要在对话中将内容作为代码块输出。
写入后,简要确认更改内容(例如:“添加了 update-readme 技能,移除了过时的 apple-events 前置要求说明。”)。
参考资料
references/template.md——起草时加载 README 结构模板。