SuperAPI AI 工具集

review-readmes

写作与研究

查看项目

更新于 10-16 03:11

技能介绍

用途:审查仓库内所有 README.md 文件,针对语言质量与事实准确性做审计,并在需要时直接修改文档。

主要能力:

  1. 收集文档:使用 find . -name 'README.md' -not -path '/node_modules/' 找出全部 README,并逐份完整阅读。
  2. 语言质量检查:查找拼写错误、语法错误、措辞生硬或含义不清的句子、损坏的 Markdown 格式,以及可精简的冗余表述。
  3. 与代码交叉核对:把 README 中的陈述与当前代码库逐一比对,确认是否仍然成立;要求核实而非猜测。
  4. 修正:将修改直接应用到 README 文件中,并对每份文件简要说明改了什么、为何修改。

使用方式:当用户要求审查 README、检查文档准确性或校对文档时调用该技能。

适用场景:文档维护、发布前检查、代码变更后的文档同步审查。

限制:资料未说明支持的平台、依赖或安装方式;命令中的路径与排除规则需按实际仓库调整;是否可自动提交变更暂未提供。