用途
good-readme 用于为 GitHub 项目创建和改善 README 文档。当用户想要撰写新的 README、改进现有 README、审计 README 质量，或提出相关请求时，可以使用该技能。
其核心理念是：README 是项目的门面，应当在 30 秒内回答“这是什么、为什么值得关注、如何使用”。每个章节都应服务于读者的真实需求，而不是用模板化内容填充。好的 README 可扫读、诚实、了解目标读者，先给出清晰的价值主张，展示真实使用示例，并尊重读者时间。开发者评估一个项目时，会在不到一分钟内决定是否继续投入，README 就是你的推介。
主要能力
该技能提供两种工作模式：
1. 创建模式——新 README
适用于没有 README 或需要从零撰写的项目。
写作前的准备：
- 阅读项目源代码以理解其功能
- 确定目标读者（终端用户、开发者，还是两者）
- 检查现有文档、配置文件和 CI 设置，以了解项目约定
- 查看 package.json / Cargo.toml / pyproject.toml / go.mod 等项目元数据
- 询问用户：“这份 README 面向谁，你最希望他们理解的一件事是什么？”
写作流程：
- 起草标题和一行描述（钩子）
- 撰写简洁的“是什么与为什么”章节（最多 2-4 句）
- 添加快速开始，让读者以最少步骤从零到可用
- 包含真实、经过测试的代码示例，而非伪代码
- 添加适合该生态的安装说明
- 只添加该项目真正需要的章节
- 在定稿前将草稿提交用户审阅
2. 改进模式——现有 README
适用于已有 README 但需要增强的项目。
先审计：
- 完整阅读当前 README
- 阅读项目源代码，检查 README 是否准确、最新
- 对照质量检查清单打分
- 找出缺口、过时内容和多余章节
- 向用户呈现发现结果和具体建议
再改进：
- 先修正事实性错误（错误的安装命令、过时的 API 示例）
- 处理结构问题（缺失章节、顺序不当）
- 提升清晰度和可扫读性（标题、代码块、列表）
- 删除没有价值的模板化内容
- 验证所有代码示例可运行
- 将改动提交用户批准
关键原则
- 以价值开头——前 3 行决定读者是否继续读下去
- 展示而非讲述——代码示例优于文字描述
- 对范围保持诚实——说明项目做什么，也说明不做什么
- 尊重生态约定——npm 项目与 Rust crate 的写法不同
- 保持维护——说谎的 README 比没有 README 更糟
- 链接而非重复——深入内容指向 docs/，保持 README 聚焦
- 测试你的示例——损坏的代码示例会瞬间摧毁信任
逐节检查清单
- 标题清晰且具描述性（不追求花哨）
- 一行说明用平实语言解释“是什么 + 为什么”
- 快速开始让读者在不超过 5 步内达到“它能工作”
- 代码示例真实、经过测试、可复制粘贴
- 安装说明覆盖项目实际生态
- 没有孤立章节（每个章节都有用途）
- 徽章有用，而非装饰
- 声明许可证
- 如果接受贡献，则包含贡献章节
参考文件
该技能附带以下参考文件：anatomy.md 提供逐节指导，examples.md 收录广受好评项目的模式，anti-patterns.md 列出常见错误，cloudflare.md 说明 Cloudflare 生态的约定。
适用场景
- 为全新 GitHub 项目撰写第一份 README
- 改进已有但质量不佳或过时的 README
- 审计 README 质量并获取具体改进建议
- 需要遵循特定生态（如 Cloudflare）约定的 README
限制
资料未提供该技能的具体安装命令、收费方式、支持平台或运行环境要求。