用途
write-readme 用于撰写或评审开源项目的 README，适用对象包括库、CLI 工具，以及供编码智能体调用的智能体工具。它的读者设定是“注意力很短的读者”：读者只想知道这是什么、什么时候用、如何开始、不该期待什么。
主要能力与工作流
技能内置一套工作流：
- 收集上下文：要解决的问题、目标受众、现有替代方案、最锐利的价值或证明、非目标。
- 一次性归类：库、CLI/工具，还是智能体工具；不清楚时先询问。
- 先削减再添加：删掉重复的清单、徽章噪音、营销话术，以及从 --help 照搬的表格。
- 按倒金字塔顺序起草：直白价值、安装、常见用法、边界，之后才是可选的参考内容。
- 把最常见的调用或导入路径放在前 30 行。
- REFERENCE.md 只用于选择章节，不是必须遵循的模板。
- 最终检查：每一行都必须回答读者可能的问题，或改变读者的下一步行动。
开头规则
- 以具体价值开场：指标、具名能力或鲜明的差异化点。
- 不要以“A library/tool that...”开头，要先呈现读者获得的结果。
- 尽早点明目标受众和非目标。
- 主张需要证据或方法论说明。
- 保持真诚，避免“seamless”“instant”“powerful”“no re-explaining”等广告词，除非 README 能证明它们。
- 优先使用普通用户口吻而非产品说明书口吻；第一人称笔记在指明真实日常用途时可用，若变成品味展示、炒作或玩笑则删掉。
- 先打开工具所解决的人类时刻，再说明机制。“I was here, this helped” 优于 “this solution enables...”。
削减清单（Ruthless Cut Pass）
删除或压缩以下内容：
- 重复出现的受支持平台或集成列表；只在影响命令语法或安装的位置列一次名称。
- 当 --help、生成文档或包文档已经覆盖时，不再放完整的参数/参考表格。
- 不影响信任或安装决策的徽章。
- 把同一句话重复表述的 “What it does”“Features”“Why” 等分散章节。
- 冗长的注意事项；保留边界，但以简短的操作性事实写出。
智能体工具的特殊写法
对于供编码智能体调用的 CLI：
- 把 README 当作该工具的函数签名。
- 展示确切的命令形态、必需参数、重要标志，以及在有助于智能体验证工作时给出预期的成功/错误输出形态。
- 添加 Not for X 的护栏，避免智能体误用。
- 让核心接口无需展开 <details> 即可扫读。
不可妥协事项
- 安装/快速开始先于架构说明。
- 局限单独成节，不要埋在注意事项里。
- 宽泛的支持声明必须点名平台、格式、语言或集成。
- 故障排查只在失败常见且可操作时才写进 README。
- <details> 只用于高级配置、原始数据、方法论或替代安装方式。
- 不使用营销形容词；用数字、示例和具名证据。
- 默认不使用戏剧化的连接节奏：破折号、箭头、“not just X, but Y” 需要有理由。
- 模板、徽章模式、截图指引、语气说明和最终检查提示见 REFERENCE.md。
适用场景与限制
该技能适用于为开源库、CLI 工具和智能体工具撰写或评审 README。关于其支持的具体平台、安装方式、收费或价格信息，资料未提供。