跳到主要内容

第一节 — 文档角色与读者

这一节回答:这份文档是什么,怎么用。

这是什么

FinBayes 工程架构文档是 FinBayes 系统设计的总图。它从战略白皮书与产品定义文档派生,把战略层的"为什么做、做什么"翻译成工程层的"系统是什么样的、怎么动、怎么部署、怎么演化"。

怎么用

按需查阅,不需要从头读到尾。

  • 写代码时:去"系统全景"找当前要实现的子系统;去"系统运行"找跨模块协作的时序;去"代码仓位置映射"找代码落点
  • 设计评审时:先读"业务架构"建立总体认识,再核对要评审的模块所属子系统
  • 遇到模糊点:查"架构决策索引",每个关键决策在 decisions/ 下有独立文档说明上下文与结论
  • 接手维护时:从"立架"三节开始建立坐标系,再按需 zoom in

与上下游文档的承接

  • 战略白皮书:FinBayes 是什么、战略不变量、阶段范围
  • 产品定义文档:用户行为契约、任务类型、输出认知要素
  • 本文档:把上述两份内容落到模块、接口、数据、部署
  • 第三方基线评估:从现有 martinpmm/Finclaw 工程仓如何演化到本文档定义的形态
  • Harness Workflow 与里程碑规范:按节奏切片实施本文档定义的内容

任何冲突以战略白皮书与产品定义文档为准,本文档须修正。