SuperAPI AI 工具集

better-readme

通用与其它

查看项目

更新于 10-16 09:54

技能介绍

用途:审计并重写项目 README,使其符合 noffle《Art of README》的“读者漏斗”原则。核心观点是文档本身定义项目做什么、承诺什么稳定,应让每位读者尽可能快速地评估是否适合自己,尽早放弃也算成功。

主要能力与结构:按漏斗顺序组织内容:名称→一句话简介→(陌生领域先给背景)→可运行的用法→安装→API(或链接)→注意事项→贡献→许可。库类项目若价值在 API,顺序为用法→API→安装;应用、CLI 等无外部 API 的工具,安装/设置在用法之后,API 段可不存在。非宽松许可(AGPL/SSPL 等)应在顶部徽章或提示,全文放底部。承载关键信息的图片须存放在仓库内,而非外部主机。

审计要点:常见失败模式包括维护者内容(发布手册、CI 密钥表、目录树、调试指南)与消费者内容混杂;漏斗崩塌(前 50 行就讲内部细节);同一事实重复两三次;以单一工具为中心的表述已过时或错误;死链与漂移的版本范围;仓库内 API 文档未被 README 链接。

使用前检查:先 git status,工作区脏则在基于 origin/main 的新 worktree 中操作;将分支与 origin/main 做 diff;grep 测试和 CI 中固定的 README/CONTRIBUTING 字符串;检查派生文档(打包用 README、网站副本、生成文档)。

重写规则:只保留消费者内容并保持漏斗顺序,维护者流程移到 CONTRIBUTING.md 或 docs/ 并留链接;每个事实只保留一处;用法段须是真实可复制的交互(命令、提示、代码),CLI 应展示调用与输出;深层细节压缩为表格并链接参考文档;每条沿用的事实都要对照代码重新核实;测试若固定措辞,应改为断言需求(如两种安装路径的顺序、链接存在)而非文档形态,且不得静默削弱测试。作者的偏好(星标图、徽章等纯装饰)优先保留,删除前先询问。

翻译版 README 要求:意译而非直译,保留社区习惯用英文的术语,结构与原文完全镜像,两文件顶部互相链接,同步更新中文锚点链接。

交付前验证:检查所有相对链接与资源可解析;运行所有读取 README 或 CONTRIBUTING 的测试;以陌生人视角通读并找出会放弃的位置;用决策清单(移动了什么、删了什么及原因、改了哪些断言)报告改动。

限制:资料未提供具体安装命令、平台支持、收费或价格信息;框架原文的本地副本位于 references/art-of-readme.md,上游仓库链接已离线。