Skip to content

代码地图

是什么

代码地图是一份"需求 → 代码"的追溯索引。它记录的是:每个需求对应改了哪些文件、哪些函数、哪些测试,以及行为场景和实现代码之间的对应关系。

它不是普通的项目总结,而是一份可追溯的对照表——后续维护者可以从需求找到代码位置,也可以从代码反查当时的设计意图。

为什么需要它

功能做完后,如果没有"需求 → 代码"的映射,三个月后再看这段代码,就必须重新翻计划、翻实现记录、翻提交历史才能搞清楚"这里为什么这样写"。这会增加维护成本,也容易让旧约束被新需求无意破坏。

代码地图让实现结果可追踪:谁改的、为什么改、改了哪里、验证了什么,一目了然。

它是怎么生成的

代码地图在质量门通过后自动生成,保存为 implementation-mapper.md。通常包含:

  • 每个需求条目对应的代码文件和关键函数
  • 行为场景对应的实现代码和验证证据
  • 重要的设计决策和约束说明
  • 后续变更时需要特别关注的入口点

你不需要手动创建代码地图,但需要确保行为场景和测试证据写得清晰——输入越清晰,生成的地图越准确。

与其他机制的关系

代码地图和 BDD 与集成测试 紧密相关,因为行为场景会被映射到具体的实现代码和验证证据。

归档时,代码地图会一并保存到归档目录,后续新需求的 契约扫描 会读取它,帮助新任务理解已有实现的边界。

Released under the MIT License.