SuperAPI AI 工具集

readme-optimization

通用与其它

查看项目

更新于 10-16 08:44

技能介绍

用途:审计并重写仓库 README,使从未见过项目的开发者能快速知道项目是什么、为何优于替代方案,并跑通第一个示例;同时保留“决定不用”这一正确结果,不刻意优化掉。

主要能力:先产出评分卡(Band A 五项阻塞检查:身份、安装可运行、声明可验证、状态诚实、许可证可达;Band B 八项计分检查),再逐段重写。步骤包括:声明目标读者并确认 README 是否为瓶颈(依据访问量与克隆/访客比);收集证据(通读、运行 scripts/readme-audit.sh <repo-root>);评分;按每小时收益排序修复;逐条核验声明与安装路径;按认知漏斗重写;校准徽章。

使用方式:回答访谈问题(1-4 决定改写方向),用户同意诊断后再改写。记忆可存于 devrel-context.md。

适用场景:GitHub 有流量但无安装、发布前重写 README 顶部、面向企业评估者等。

限制:不覆盖文档站、入门页、贡献路径等,应转其他技能;不得引用无来源的民间统计;无法执行命令时须说明并请用户运行;性能、兼容性等声明须有仓库内来源,否则降级或删除。