SuperAPI AI 工具集

research-codebase-readme-writer

写作与研究

查看项目

更新于 10-15 23:43

技能介绍

用途:为研究代码仓库编写或审查 README.md,核心目标是让任何人(包括半年后的作者本人)仅凭 README 就能复现主要结果,无需向作者提问。

主要能力:识别并避免两类失败模式——装饰性 README(有标题、示例和引用,但缺少数据下载步骤、参数已变、脚本与论文结论对应不明)和动机型 README(大谈问题意义,却不说明数据放哪、训练多久)。生成按固定顺序组织的 README,包含:文件顶部一行可证伪的核心结论声明;复现主要结果(三条以内命令,含预期输出与大致运行时间);结果映射表(把论文结论对应到脚本、输出与运行时间);项目布局(每个文件夹一行,说明用途);安装步骤(精确到曾在新机器上出错的修复方法);数据说明(提交、下载还是生成,合成数据含随机种子);已知问题与坑(不支持的功能、慢的地方、需要特殊参数之处)。

使用方式:若用户已有 README,先阅读并找出缺失或损坏的部分,通常从结果映射入手,直接重写或扩展而非仅加注释;若从零开始,向用户询问论文的主要量化结论、产生它的脚本与预期输出、数据是提交/下载/生成、以及曾出错的非显然安装步骤,其余可从代码库推断或生成占位符;若只需快速骨架,提供带 [TODO] 标记的完整模板。

适用场景:学术论文配套代码、实验复现仓库、需要向审稿人或协作者交付可运行代码的项目。

限制:应省略摘要与动机、标准包安装说明、贡献指南、徽章(除非 CI 实际运行)和变更日志(应放 CHANGELOG.md)。最终需自检:他人克隆仓库后能否仅凭 README 复现主要结果。资料未提供具体收费、平台或效果信息。