文档地图
1. 当前启用模块
- 入门说明:面向第一次接触项目的维护者、评审者和协作者,回答“这是什么、先看什么、怎么开始”。
- 用户指南:面向源仓接入负责人、部署维护者和日常操作人,回答“怎么接入、怎么构建、怎么部署、怎么维护”。
- 项目开发文档(内):面向需求、架构、研发、测试、发布和运维协作者,回答“需求是什么、设计是什么、过程怎么推进、风险怎么控制”。
- 当前暂不单独启用开发者指南:项目尚未形成稳定 SDK、公共 API 或插件扩展面;现阶段的接入标准和实现约束由用户指南与内部设计文档承载。
2. 阅读建议
- 第一次接触项目:先看入门说明
- 需要接入源仓、执行构建或部署:看用户指南
- 需要参与需求、设计、测试、发布和运维:看项目开发文档(内)
- 若后续形成稳定对外扩展能力,再补启开发者指南
3. 内部模块说明
- 项目治理:说明项目边界、目标与治理约束。
- 调研与决策:记录输入背景、问题澄清和关键决策。
- 需求:沉淀 PRD、需求分析和一致性校验。
- 设计文档:说明技术选型、架构、模块边界与接入标准。
- 开发过程文档:维护计划、拆解和执行过程。
- 测试与验证:说明测试策略、用例和结果。
- 发布与交付:沉淀验收、交付包和发布说明。
- 运维与维护:记录部署、运行和故障处理方法。
- 演进复盘:沉淀复盘结果和后续改进项。
- 追踪矩阵:维护需求、接口和文档的追踪关系。