产品软件详细设计说明书.doc

福建视通 软件详细设计说明书V1.1*软件详细设计说明书福建省视通光电网络有限公司文件状态： 草稿 正式发布 正在修改文件标识当前版本V1.1作 者刘祖钦完成日期2013 03.12版本历史版本/状态作者完成日期备注V1.0刘祖钦2013 03.12创建文档模板V1.1刘祖钦2013.03.26修改3.4函数要求,当成可选章节目 录第一章 引言- 4 -1.1目的- 4 -1.2范围- 4 -1.3术语、符号、定义- 4 -1.4参考资料- 4 -第二章 软件代码概述- 4 -2.1系统流程图- 4 -2.2代码目录结构- 5 -2.3 源文件与模块的关系- 5 -2.4 加载文件与模块关系- 5 -第三章 任务1（模块1）设计说明- 5 -3.1 程序描述- 6 -3.2 程序资源或逻辑- 6 -3.3 流程逻辑- 6 -3.4 函数- 6 -3.5 算法- 6 -3.6 数据结构和类- 7 -3.7 限制条件- 7 -3.8 接口实现- 7 -3.9 测试或调试计划- 7 -3.10 可靠性设计- 7 -3.11 故障处理机制- 8 -3.12 参考资料- 8 -第四章 任务2（模块2）设计说明- 8 -第一章 引言1.1目的1.2范围1.3术语、符号、定义序号符号、缩略语、术语定义1.4参考资料第2章 软件代码概述2.1系统流程图2.2代码目录结构【说明系统源代码文件存放的目录、子目录，及其包含的文件列表。如下】目录名称目录说明包含源文件列表2.3 源文件与模块的关系【如下表格式对系统包含的源代码文件进行大致说明】任务（模块）名称文件名称文件描述任务（模块）1文件1*.h*模块头文件，包含数据结构声明 宏定义 函数声明*.c*模块实现文件，包含数据结构初始化和函数定义文件n2n2.4 加载文件与模块关系【如果有些文件是第三方提供，请列举出来并说明其用处。可能需要描述对外接口函数的定义，以及如何使用。 如果未涉及，本节可以省略】第三章 任务1（模块1）设计说明3.1 程序描述3.2 程序资源或逻辑【说明本程序或任务模块占用资源（如：内存使用、常用寄存器的，变量使用状况，ROM或RAM使用状况，程序指针的地址，外部中断几种方式，预定义方面的备注等）】【内部内存分配，全局变量 常量如何定义 】3.3 流程逻辑3.4 函数【本小节为可选，根据实际情况进行填写】函数名称函数原型输入参数Int B 波特率输出参数返回值函数功能3.5 算法3.6 数据结构和类。3.7 限制条件。33.8 接口实现3.9 测试或调试计划。3.10 可靠性设计【针对外部可能触发条件或软件内部运转环境，来对本任务块做个预判性防御分析和解决措施设计，保证软件设计功能的可靠性】问题分类问题及影响描述严重程度解决措施是否关注/原因软件问题死机，程序出错严重加软件看门狗是硬件问题时钟老化，晶振不稳定，一般否，因为器件不稳，我们可以更换。硬件问题信号异常，不太稳定严重加算法检测，保证其稳定是【填写指导：1、对存在的问题提出可操作的解决措施，多个解决措施要按重要程度排序2、问题分类选项为：硬件因素包括EMC干扰，电源不稳，IO口出现异常，信号异常，异常复位，时钟老化等。软件问题 包括程序指针错乱，内存空间不足，中断引用错乱，中断资源暂用，软件延时不当，任务进程堵塞，系统崩溃等。3、严重程度包括致命、严重、一般、提示。（一般不考虑致命选项）4、设计不关注时需注明简要原因。】3.11 故障处理机制【描述本任务块出现故障时，我们应如何处理，以及进入故障