研究方法记录 是做什么的?
生成一份 METHOD.md 文件,其他研究人员或 AI 代理无需访问产生该方法的对话即可遵循。
步骤
- 划定边界。 说明该方法回答什么问题,输入什么,输出什么。如果对话中包含多个方法,则每个方法单独写一个文件。
- 首先收集来源信息。 谁推导出的(人工、代理或两者)、使用了哪些工具和模型、哪个技能或提示、以及日期。缺失的信息应询问,不要猜测。
- 从以下模板编写
METHOD.md。如果目标仓库中有methods/_template/METHOD.md,则使用该模板,因为它可能更新。 - 使过程可执行。 编号步骤、准确的命令或公式、参数默认值以及预期运行时间。
- 使验证具体明确。 命名测试、数据集或完整性检查,证明方法有效,并记录实际观察到的数字。
- 记录局限性 以及在开发过程中发现的失败模式。
- 诚实设置
status。 在验证观察到结果之前为draft,检查通过后为validated,论文中引用后为published。
规则
- 仅记录实际运行或推导出的内容。任何未测试的内容都要标记为未测试。
- 保持文件自包含。链接到代码,而不是粘贴大段代码。
- 使用通俗语言。读者可能不熟悉该方法所在项目的术语。
- 不要编造来源信息。未知模型或日期写作
unknown。
模板
---
name: <文件夹名称>
description: <一句话:它的用途和何时使用>
status: draft
origin: human | agent | mixed
agent: claude-code | codex | none
model: <模型 ID 或 unknown>
skill: <链接到使用的 SKILL.md,或留空>
derived: YYYY-MM-DD
---
# <方法名称>
## 摘要
## 问题
## 输入与输出
## 过程
## 验证
## 局限性与失败模式
## 来源
## 应用场景
## 参考