项目刚开始时,实验不多,靠文件名和记忆也能推进。几个月后,README 混着旧结论和待办,计划散落在子目录与聊天记录里,同一件事还可能有几种说法。此时最难回答的,通常是当前主线在哪里、下一步做什么,以及当初为什么这样选择。
解决这类混乱,需要先给文档划清职责,再规定信息完成后往哪里走。
Summary
每条信息只在一个位置详述,计划完成后从 NEXT 移入 README,再按需要向 INDEX 和根 README 收编。
四类文档各管一件事
README保存已经确定的信息。根 README 说明项目定位、当前主线和里程碑;实验 README 记录这次实验的方案、配置、产物与结论。未完成计划不要放进 README。INDEX是实验注册表。它不展开单个实验的细节,只记录编号、作用、状态、一行摘要,以及实验之间的接替、并行或归档关系。NEXT是当前实验唯一的计划入口,只保留尚未完成的方向。完成事项离开 NEXT,避免它逐渐变成一部无法阅读的编年史。explain专门解释“为什么”,用于保存机理、方法比较和依据。实验 README 要列出这些文档的入口,否则写了也很难找到。
让信息沿一个方向收编
这套结构的核心是一条单向信息流:
NEXT → 实验 README → INDEX → 根 README一个方向完成后,先把做法和结论重写进实验 README,再从 NEXT 删除原计划。实验状态发生变化时,INDEX 更新一行;只有影响项目主线或全局约定的内容,才进入根 README。explain 保留推理和依据,由实验 README 提供索引。
同一条事实只保留一个详述位置。上层文档负责摘要和导航,不复制下层细节。这样修改结论时只需维护一处,也能减少旧版本继续留在项目里的机会。
这套结构适合需要长期维护多次实验的项目。单脚本任务或短期分析,一份 README 通常已经够用。整理旧项目时,可以先建立 INDEX,确定当前实验唯一的 NEXT,再把仍在使用的结论收回对应 README。以后每完成一个方向,就沿这条信息流处理一次。