文章内容

2026/4/1 18:30:01,作 者: 黄兵

EXPERIMENT_LOG.md CHANGELOG_RESEARCH.md 这两个文件区别

1. 两者的核心区别

文件名侧重表达的意思适合的场景
CHANGELOG_RESEARCH.md变更日志(研究版)侧重于记录代码改了什么。适合像你这样由 Codex 生成了详细 Summary 的情况,把这些 Summary 按日期排好序。
EXPERIMENT_LOG.md实验日志侧重于记录为什么要改、想测什么、结果如何。对于量化交易这种需要“观察几天看数据”的工作,这个名字更贴切。

EXPERIMENT_LOG.md(实验日志)

因为它不仅记录了“代码变动”,还记录了你的“主观意图”和“测试反馈”。

建议的结构(直接复制到你的项目根目录):

# 量化交易实验日志 (EXPERIMENT_LOG)

## [2026-04-01] 优化扫描频率与 AI 剪枝逻辑
- **关联 Commit**: `a1b2c3d` (或是 Git Tag: `v2.1-beta`)
- **更改原因**: 4H 周期下 AI 唤醒过于频繁,Token 消耗过快,且在横盘期产生无效调用。
- **更改内容 (Codex Summary)**:
    - `main.py`: 新增双档扫描(空仓15min/持仓60s)。
    - `PureAIReasoningStrategy`: 引入 `_has_reversal_risk` 剪枝逻辑。
- **测试计划**: 观察 4 月 1 日 - 4 月 7 日的实盘/模拟盘表现。
- **预期目标**: Token 消耗降低 30% 以上,且不漏掉重大的趋势反转。
- **实验结论**: (待填写)

3. 为什么这种方式比博客好?

  1. 离代码最近:你在 PyCharm 里写代码,改完顺手在左侧文件树打开这个 .md 文件改一下,不需要打开浏览器登录博客。

  2. 版本同步:这个日志会跟着你的代码一起 git push 到 GitHub。你回滚代码的时候,这个日志也会回滚到当时的状态,让你瞬间想起“当时的自己在想什么”。

  3. 方便搜索:在 PyCharm 里按 Ctrl + Shift + F 全局搜索“RSI”,能立刻找到哪次实验修改了 RSI 逻辑。

总结

别纠结名字了,就用 EXPERIMENT_LOG.md 吧!

  • Commit Message:写短标题(给 Git 看)。

  • EXPERIMENT_LOG.md:粘贴 Codex 的长段 Summary,并写上你的测试起止时间和预期(给你自己看)。

如何在 EXPERIMENT_LOG.md 继续往下写?

建议继续在同一个文件中追加内容。

在软件开发和量化研究中,保持一个单一的“真相来源”(Single Source of Truth)是最高效的。

为什么不建议新建文件?

  1. 全局搜索(Ctrl+F)更强大:如果你想找“RSI 逻辑是什么时候改的”,在同一个文件里搜一下就能看到所有历史变动。如果分了 10 个文件,你得一个一个点开。

  2. 纵向对比更直观:你可以轻松滚动鼠标,对比 4 月 10 日的策略逻辑和 4 月 1 日有什么本质区别。

  3. 保持目录整洁:随着项目进行,你可能会产生几十次实验。如果根目录下全是 .md 文件,会掩盖掉真正的核心代码文件。

最佳实践:采用“倒序排列”(Reverse Chronological Order)

最新的记录写在文件的最上方。这样你每次打开 EXPERIMENT_LOG.md,第一眼看到的就是当前正在进行的实验,而不需要滚屏到底部。

推荐的文件结构:

# 量化交易实验日志 (EXPERIMENT_LOG)

## [2026-04-10] 实验:引入波动率自适应止损
- **状态**: 🟡 正在测试 (预计至 04-17)
- **关联 Commit**: `e5f6g7h`
- **更改原因**: 发现原有固定点位止损在剧烈行情下容易被“插针”导致误扫损。
- **更改内容**: 
    - 引入 ATR 指标,止损位设为 2*ATR。
    - ... (粘贴 Codex 生成的 Summary)

---

## [2026-04-01] 实验:双档扫描频率与 AI 剪枝
- **状态**: ✅ 已完成 (Token 消耗降低 35%,表现稳定)
- **关联 Commit**: `a1b2c3d`
- **结论**: 逻辑有效,长期保留。
- **更改内容**: 
    - ...

进阶建议:利用 Git Tag 锚定日志

每当你完成一次更改并在 EXPERIMENT_LOG.md 记录后,在 Git 中打一个 Tag。 在 PyCharm 的终端输入: git tag -a v20260410 -m "ATR自适应止损测试版" git push origin v20260410

这样,即使过了半年,你在 GitHub 的 Tags/Releases 页面看到这个日期,点进去就能看到当时的所有代码快照。

通过这种方式,你的开发流程会变成:

  1. Codex 编写代码 -> 2. PyCharm 提交代码并记录 Commit ID -> 3. 工具生成 Markdown -> 4. 粘贴到 EXPERIMENT_LOG.md 顶部

这套流程能确保你在几周后回滚代码时,不仅有代码,还有当时深思熟虑的“逻辑支撑”。

分享到:

发表评论

评论列表