用途:在用户要求“update the README”“sync the docs”等时,让 README.md 与 README.zh-CN.md 反映项目当前真实状态,两份文件须准确、完整且彼此一致。
主要能力:先勘察项目状态,扫描所有 skill/模块目录及其 SKILL.md 或等价描述文件,记录各组件名称、一句话用途、安装方式与前置条件,查看 git log 中的新增或删除,并读取现有 README 找出过期内容;随后以 references/template.md 为结构起点起草英文 README;再忠实翻译为简体中文 README;写入前做一致性复核。
使用方式:定稿前核验清单中每个 skill/组件当前确实存在于仓库、安装命令可直接复制粘贴且准确、没有章节描述已被移除的内容、两份文件覆盖相同内容且顺序一致。写入时优先用 Edit 或 Write 工具直接写文件,不要把 README 内容作为代码块输出到对话里。
写作规范:两份 README 都必须以固定头部结构开头,包含语言切换;为 README.zh-CN.md 时切换为 English | 简体中文。徽章要反映项目真实情况,如 CI 状态、许可证、语言/运行时版本、包注册版本、覆盖率,无实时端点时用 shields.io 静态徽章,超过两个徽章建议用引用式链接。章节顺序为头部、一句话描述、可选 logo/banner/演示 GIF、主要内容章节、贡献或新增条目、许可证;超过约 300 行加目录。README 是目录而非教程,每个组件描述控制在一两句,代码块须带语言标签如 bash、json。行文避免营销腔与 AI 套话(如 leverage、streamline、robust、utilize、delve,以及 powerful、seamless、comprehensive),不要每条都以加粗短语开头,避免“serves as”式表述,减少填充转折词和破折号,Unicode 箭头改为纯文本。中文版用自然简体中文,通用英文技术术语、CLI 名称、包管理命令、GitHub URL 与代码块保持原样,文件路径和命令与英文版一致,标题用惯用中文表达。
限制:所有内容须来自仓库真实状态,不得凭记忆或假设编写;列出的 skill/组件必须当时确实存在;失效或长期失败的徽章不如不放。资料未提供具体项目背景、仓库地址与安装命令,相关细节暂未提供。