文档之产品的软件设计方案的编写框架

## 设计方案的组成

1. 产品系统设计方案 = 硬件方案 + 软件方案 + 结构方案

2, 产品硬件设计方案

3. 产品软件设计方案

4. 产品软件配置表

## 产品硬件设计方案

## 软件方案

1、引言

• 编写目的（指导开发）
• 项目背景（为什么需要该产品，开发后主要用于干嘛？如：提供网络交换服务？提高网速？实现空地通信之类）
• 术语定义（文档中可能涉及到的一些缩写术语，全称及含义解释）
• 适用范围（适用于所有的设计和开发过程）

2、总体设计

• 运行场景（采用产品部署时拓扑图进行示意图表示~）
• 运行环境（硬件环境、软件环境）
• 软件架构（采用Android的层次方式进行说明-硬件、系统、中间层、APP层）
• 启动流程（活动流程图，外界详细的流程说明）

3、接口设计

• 接口概述（绘制总体部件的内部、外部接口的拓扑示意图，
•                   如：Server/ADB/CMT/SLCD等外部连接、连接方式串口/网络/arinc429等，
•                   server_suu、cmdmodule、server_cma、log_module模块间的通信，通信方式-IPC、Socket、SharedMem）
• 模块定义（产品ADB具体的模块组成，如：cma/log/control/upgrade等，
•                   对每一个模块进行详细的定义：是什么？主要负责干什么？完成那些任务？主要功能列表包含？）
• 外部接口（外部接口是什么？连接与那两个产品（server-adb）？具体的连接方式是什么（socket）？绘制时序图进行具体描述该段连接？
•                   具体的通信协议定义格式--请求格式？回复格式？同http字段一样...）
• 内部接口（系统级别接口(系统调度)、模块级别接口、其它具体模块间的接口、
•                   对于模块间存在特殊调度的情况，请采用时序图进行详细的说明是如何的调度完成通信的
•                  ）

4、数据结构

• 数据结构定义（IPC、Socket、Snmp等通信方式采用的数据结构typedef，通信的数据类型）
• 消息结构定义（主要定义具体可能传递的消息值，如：状态上报、KeepAlive、获取版本、控制重启、开启LCD、升级LCD、日期同步、网络设置等...）

5、异常处理

（主要描述将采用哪些手段、方案来处理异常：如采用系统日志记录所有的异常信息、终端查看、排故障）