SuperAPI AI 工具集

awesome-readme

通用与其它

查看项目

更新于 10-16 06:42

技能介绍

用途:创建、审计、修订和标准化项目 README,依据仓库证据决策,而非凭空编造。

主要能力:先用 python3 scripts/inspect_project.py --root <repository> --target <README-path> 扫描项目事实;再阅读工具引用的规则、清单和现有 README,优先信任项目规则与清单。自行判定可见性与项目类型,按需加载其余指南,建立证据账本,记录声明、命令、链接、读者路径、责任人和缺口,并把每个命令先标记为“已声明”。

使用方式:先运行扫描再起草;用项目根和 README 路径运行散文检查,逐条修复错误后重跑。退出码 1 表示仍有错误,退出码 2 会阻止交付,需说明缺失工具、版本错误或包同步失败并给出修复,不得声称检查通过。交付前检查本地链接,尽可能运行安全命令,命令只有在运行通过或有明确 CI 证据时才算已验证。

限制:不要打开或展示密钥、令牌或 .env 值;不得编造命令、链接、徽章、赞誉、证明或支持声明;同项目文件用本地链接;不确定的小事实可省略,但需列出省略项;缺失事实暂未提供。分类据其文档生成用途,归入写作与研究。