一个开发文档模板

目录

需求背景

接口文档

系统间关系

系统内模块

环境信息

容量预估

容灾容错

监控告警

代码变更

上线方案

---

需求背景

简单描述需求背景，详细内容可以贴PRD链接，重点表述对技术侧的影响。

示例：为了支持xxxxx，我们需要构建一个具备灵活扩展能力的xxxxx。

接口文档

可以贴接口文档链接，如swagger、yapi等。

系统间关系

使用数据流向图或者调用关系图来表达现有系统与外部系统的关系。比如数据/请求是谁发起的，在大的系统架构上处于什么位置。数据流向图/调用关系图提供一个即可。

对于数据为主的应用，建议使用数据流向图。

对于调用为主的应用，可以使用调用关系图。

系统内模块

使用时序图或者流程图来表达内部处理逻辑，或者不同模块之间的执行顺序或者关系。

环境信息

略。

容量预估

	类型
1	接口性能	qps峰值 xxx 响应时间 TP99 和 TP9999 预计 xx 压测时性能下降不能超过 10%
2	中间件	涉及数据新接入的 新增 每天新增数据xx 一年后预计数据量 xxx 数据保留xxx （多久） 如何操作老数据的过期 全量 每天数据量多少 单条数据多大 保留几个版本 中间件是否需要进行内存/磁盘的扩容

容灾容错

容灾：是否要应对可用区级别的异常，一般来说只有一级系统需要。

容错：主要针对外部系统，或者依赖的其他组件/服务异常时，当前服务需要做哪些事情，来保证功能正常。

监控告警

针对系统是否要在上线前，配置好对应的监控和告警。建议格式。

监控地址：XXXXX

告警项：

1. 流量突增超出阈值告警，当前阈值xxx。
2. 流量突降超出阈值告警，当前阈值yyy。
3. 流量低语阈值告警，当前阈值zzz。
4. 服务存活告警。
5. 错误数超阈值告警，当前阈值hhh。

代码变更

罗列重要代码变更。

上线方案

用于描述上线过程，尽可能细化。可以使用里程碑的时间。必写回滚方案。