SuperAPI AI 工具集

readme-expert

通用与其它

查看项目

更新于 10-16 07:59

技能介绍

用途:README Expert 用于创建或校验 README.md,核心是“验证优先”,让文档内容以真实代码库为依据,减少 AI 生成 README 时的幻觉。

主要能力:扫描代码库提取项目事实;按项目类型选择模板;生成 README 各章节;执行五层校验(文件存在性、内容准确性、执行有效性、链接完整性、引用可追溯性);对命令和示例做脚本执行测试;为每条声明记录来源;按 standard-readme 与 Google 风格指南做质量评估。

使用方式:根据任务选择工作流。新建或大改 README 走完整流程:扫描代码库、选模板、生成、校验、质量评估、交付。已有 README 只做准确性检查时走仅校验流程,运行五层校验并输出报告与修复建议。资料中给出的扫描示例包括 Glob 查找 package.json、pyproject.toml、Cargo.toml、go.mod,Grep 查找导出、CLI 命令和环境变量等。

适用场景:为新项目写 README;检查现有 README 是否仍准确;重构后更新 API 章节;验证 README 中的代码示例能否运行。

限制:资料未提供具体安装命令、运行环境要求、收费方式或平台支持信息。脚本执行需注意安全,破坏性命令应先获许可;置信度低于 70% 的声明应移除;资料称其可将幻觉率降至接近零,但未给出独立验证数据。