SuperAPI AI 工具集

eval-readme

测试与质量

查看项目

更新于 10-15 21:42

技能介绍

用途:评估 GitHub README 的沟通质量,判断它是否服务于“给忙碌人类看”这一目标,并区分人类撰写、未声明的 AI 生成、以及合法声明的 AI 生成三种情况。它只评判沟通质量,不评判代码质量。

输入:可以是 owner/repo(由代理通过 GitHub API 获取 README),也可以直接粘贴 README 文本。

主要能力:按三套评分标准检查。第一套看人类信号,如截图、图表、终端录制(asciinema、SVG)、视频、演示 GIF,以及可扫读结构(清晰标题、命令示例、短段落)。第二套标记未声明的 AI 痕迹,如大量 em-dash、段落长度过于统一、LLM 式措辞、套路化开头(“In today's...”“It's worth noting”)、空洞流行词、过度结构化与过度精致的 emoji;但明确面向 LLM 的 llms.txt 或 README 不受此标准约束。第三套检查必备要素:许可证、开头说明是什么与为什么、安装、带示例的用法;README 不应充当 changelog,版本历史应放到 CHANGELOG.md 或 GitHub releases。还检查仓库元数据(GitHub 描述与 topics 是否填写)、维护停止时是否有“暂停”标记或徽章、根目录是否有 llms.txt 或 llms-full.txt,以及数字一致性(功能数、对比表中的星数、版本号在 header、表格、路线图、GitHub 描述中是否一致;若来源冲突,不擅自选一个为真,而是指出分歧并说明以代码或实时计数为准)。

使用方式:获取内容可用 gh api repos/{owner}/{repo}/readme --jq .content | base64 -d,或通过 raw.githubusercontent.com 取原始 README;检查元数据可用 gh api repos/{owner}/{repo} --jq '{desc: .description, topics: .topics}'。随后依次过三套标准,给出结论并列出可立即执行的修复项。

输出顺序:结论(人类阅读、未声明的 AI 阅读、合法声明的 AI);沟通质量 5 分制评分;信号表(每套标准标绿、橙或红并附简短理由);修复建议(如清理 14 个 em-dash、顶部加演示 GIF、加一行许可证、用终端录制替代大段安装说明)。要求保持事实性,引用具体行或段落。

限制:资料未提供安装命令、收费方式、平台支持范围或效果保证;具体评分细则与信号定义参考插件根目录的 signals.md。