SuperAPI AI 工具集

good-readme

通用与其它

查看项目

更新于 10-15 22:19

技能介绍

用途:帮助创建、重写、审阅或润色开源项目的 README,也可用于项目描述。由 Evil Martians 构建,基于其打造 PostCSS、Nano ID、imgproxy、AnyCable 等开源项目的经验,配套文章为 https://evilmartians.com/chronicles/how-to-make-your-open-source-popular。

主要能力:提供一套 README 结构(被比喻为“渐进式 JPEG”),避免读者在找到关心的理由前就放弃阅读。结构包括:0. 清理,删除已有 README 中的所有徽章,若徽章含真实事实(版本、构建状态)则改用文字表述;1. 开篇段落,用平实语言回答三件事——做什么、用户能获得什么好处、与替代方案有何不同;2. 事实,紧跟第一段给出项目最重要的事实、特性和数字的要点列表,每条以 1–2 个加粗关键词开头再给证据,用真实基准数字、精确体积、与最接近替代方案的并排代码对比、截图或示意图;3. 示例,放 4–10 行自解释的小例子,并在注释中展示输出;4. 快速开始,给出加入现有项目的分步明确命令,逐步都不可省略。

使用方式:在创建或改进 README 时套用上述结构,并用完成前检查清单核对:第一段单独能否推销项目(做什么/好处/差异);每个数字和主张是否真实且来自仓库、用户或实际测量;示例是否自解释、4–10 行且展示输出;快速开始是否能在干净机器上跑通;只扫标题和加粗文字是否仍能读懂故事。排版上使用标题体现层级、加粗关键点、层间用分隔线,列表优先于密集段落,不可错过的行放引用或加粗,超过约两屏加目录。

限制:绝不虚构事实。若仓库缺少所需数据(基准、文件体积、与替代方案的真实差异、支持平台)或不确定是否准确,应向用户询问而非猜测;带编造数字的 README 比没有数字的更糟。资料未提供具体安装命令、平台支持或收费信息。