10-概要设计

xxxx公司

文件编号
当前版本	1.0.0	文件状态	草稿/发布/作废
保密等级		开放范围
编写日期	yyyy-MM-dd	作 者
审核日期	yyyy-MM-dd	审核人

保密等级: A―绝密、B―秘密、C―一般、D―无

版本历史：

版本	更新日期	变化状态	作者	简要备注说明
1.0.0	yyyy-MM-dd

变化状态：C―创建、A―增加、M―修改（+修改说明）、D―删除（+删除说明）

1. 引言

   1.1 编写目的

   1.2 背景

   1.3 参考文档

   1.4 术语解析

2. 总体设计

   2.1 需求概要

   2.2 使用流程

   2.3 后期扩展

3. 架构设计

   3.1 业务架构

   3.2 服务交互

4. 功能详细设计

   4.1 功能说明1

   • 流程说明
   • 流程图
   • 服务交互时序图

   4.2 功能说明2

   4.3 功能说明3…

   4.6 缓存设计

   4.7 定时任务设计

   4.8 数据库设计

   4.8 接口设计

5. 涉及服务及接口

   5.1 前端涉及服务

   ​ 5.1.1 服务1 - 负责人1

   ​ 5.1.2 服务2 - 负责人2

   ​ 5.1.3 服务3 - 负责人3

   5.2 后端涉及服务

   ​ 5.2.1 服务1 - 负责人1

   ​ 5.2.2 服务2 - 负责人2

   ​ 5.2.3 服务3 - 负责人3

6. 编程规范

   6.1 命名约束

   6.2 接口规范

   6.3 开发规范

7. 系统容错

   7.1 服务可靠性

   7.2 服务可用性

   7.3 故障检测

   7.4 故障恢复