简介
本文档用于沉淀 Hahaha 项目开发过程中的开发记录,交流内容与决策过程,包括但不限于:
- 项目介绍:项目是什么,什么目录结构
- 项目实现:比较上层的接口实现,内部层级间的主要接口定义
- 功能迭代讨论:为什么做、做什么、不做什么、优先级如何定
- 设计方案与取舍:多个方案对比、风险评估、兼容性与演进策略
- 实现思路:关键模块的实现路径、代码组织、踩坑与复盘
- 协作记录:达成共识的结论、待办与后续跟进
适用读者
- 新加入的贡献者:快速了解项目脉络与历史决策
- 正在实现某功能的人:对齐边界、接口与兼容策略
- 维护者:基于既有结论持续迭代,减少重复讨论
如何使用这本书
- 先看「指南」:了解目录约定与写作规范
- 再看「项目介绍」:明确范围、术语、总体目标
- 设计阶段写入「设计」:方案、接口、数据结构、边界
- 结论沉淀到「ADR」:把“决定了什么/为什么”固定下来
- 过程记录放「讨论」:会议纪要、评审意见、迭代记录