项目说明文件
README
学到 认得 就够：听到能明白
你可能会说
“我打开论文代码仓库后，怎样从项目说明文件判断从哪里开始复现？”
README通常是项目的首要说明，交代项目做什么、为何有用、如何开始以及到哪里求助。它常用Markdown编写，因此在仓库首页可以直接阅读，也可以在本地作为文本查看。
使用 AI
科研里的例子
接手教学仓库时，先从README确认数据文件是否公开、运行顺序和结果产物。
README不是程序本体，而是人与项目之间的使用契约。对科研项目，还应关注数据可得性、环境、复现步骤、适用版本和已知限制。文件存在不保证内容仍适用，操作命令应与当前代码和配置交叉核对。
动手试一次
用一段话复述项目目的，并列出仍缺失的运行条件。
在你的学科里，直接拿去用
查错并交付能核验的修复
请定位问题并给最小修复。 代码与环境：[粘贴] 输入样例：[不含私密信息的小样本] 实际错误或输出：[粘贴] 我期望：[填写] 先区分已观察事实与可能原因，优先用最小样例验证。解释根因，给最小差异和有意义的检查。没有实际运行权限时明确标为未运行建议，不把推测写成测试通过。若修改会影响研究规则或结果，指出具体影响，不顺手重构无关部分。方括号里的内容换成你自己的。来自知识增量《科研中英表达与 Prompt 指南》PG09
判断
亲手检查一次
抽取一个最小示例，核对说明、文件和实际输出是否一致。
它做不到的
README不等于许可证，也不能替代逐项测试记录或详细方法文档。
增量，由你来写
读完这张，你的理解变了什么？
留言功能会在后面的版本开放。现在可以先在 X 上 @knowledgedelta 告诉我。