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