研发规范软件总体设计文档Word格式.docx

研发规范软件总体设计文档Word格式.docx

《研发规范软件总体设计文档Word格式.docx》由会员分享，可在线阅读，更多相关《研发规范软件总体设计文档Word格式.docx（7页珍藏版）》请在冰豆网上搜索。

起草人

姓名

部门

电话

电子邮件

审阅人

签发人

文档修改记录

序

二

修改时间

修改人

主要修改

存档版本

1

2

3

4

5

6

7

8

9

10

1.引言1

1.1编写目的1

1.2背景1

1.3参考资料1

1.4术语、定义和缩写1

2•总体设计1

2.1系统需求1

2.2运行环境2

2.3方案设计及论证2

2.4总体结构2

2.5处理流程2

3.接口设计2

3.1用户接口2

3.2夕卜部接口2

3.3内部接口2

4.模块设计与算法描述2

4.1顶层设计3

4.1.1系统的功能模块划分和总体功能结构图3

4.1.2模块之间的接口描述3

4.2子模块1设计3

4.2.1设计思路3

4.2.2算法描述3

4.3子模块2设计4

4.4子模块n设计4

5.运行设计4

5.1运行模块组合4

5.2运行控制4

5.3运行时间4

6.系统数据结构设计4

6.1逻辑结构设计要点4

6.3数据结构与程序的关系

7.测试方案5

7.1系统测试方案5

7.1.1测试设计说明5

7.1.2测试内容5

7.2模块测试方案5

7.2.1测试设计说明5

7.2.2测试内容5

7.3存在的问题5

1・引言

引言是对这份软件总体设计文档的槪览，是为了帮助阅读者了解这份文档是如何编写的，并且应该如何阅读、理解和解释这份文档。

1.1编写目的

说明这份软件总体设讣文档是基于哪个软件产品编写的，以及包含软件系统开发的主要内容，可以为项目主管人员、项目经理、技术开发人员和测试人员理解需求只用。

1.2背景

说明软件开发的背景资料等。

1.3参考资料

列出本文的参考文件淸单，包括出版单位、作者、版本、日期等信息。

如：

《XXX总体需求书》（XXX单位XXX提供）

《XXX需求调研报告》作者：

XXX

行殳计模式》XXXX出版社

WML用户指南》XXXX出版社

1.4术语、定义和缩写

列出本文档所涉及的专业术语、缩写词及相关泄义。

泄义所有必要的术语，以便读者可以正确地解释软件需求规格说明，包括词头和缩写。

l）OLTP：

On-lineTransactionProcessing,联机事务处理。

2•总体设计

总体设计从需求出发，把软件按功能逐次分割成层次结构，并明确各部分之间的联系及它们如何组合起来完成系统功能方式。

包括模块划分及模块相互间的关系。

2.1系统需求

给出技术指标、功能需求等。

2.2运行环境

简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。

2.3方案设计及论证

给出所设汁的实现方案，包括总体实现方法、设计思路以及功能的划分等。

论证该方案的可行性，比如功能是如何实现的、指标是怎样满足的等。

2.4总体结构

按功能划分模块的层次结构，明确每个模块的功能，当模块与需求的对应关系不十分明显时,应明确的描述二者的对应关系。

2.5处理流程

根据需求确定程序处理的分支和步骤，描述模块间的调用关系以及在什么条件下调用以及齐模块运行的时间关系等。

可采用流程图、状态转移图等方式进行描述。

3•接口设计

3.1用户接口

说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。

3.2外部接口

说明本系统同外界的所有接口的安排，包括软件和硬件之间的接口、本系统与各支持软件之间的接口关系。

3.3内部接口

说明本系统之内的各个系统元素之间的接口安排。

4.模块设计与算法描述

给出详细总体模块设计，子模块设计的过程和方法。

让读者对整个系统设计有完全的了解和掌握。

4.1顶层设计

从全局描述系统实现中的一些考虑，比如一些算法在软件中如何实现（比如排序算法）等等。

4.1.1系统的功能模块划分和总体功能结构图

说明系统划分为哪些功能模块，并给岀总体的功能结构示意图。

4.1.2模块之间的接口描述

立义务个子模块间的接口信号。

4.2子模块1设计

4.2.1设计思路

说明本子模块所完成的功能，这些功能在软件实现的考虑。

4.2.2算法描述

本模块涉及到的算法介绍，算法中具体的处理过程，参数设计，（以及左点设计）等等。

让读者了解算法和处理过程的抽象模型，以便对后面软件实现中的处理具备理论基础。

并简要介绍相关算法：

（1）算法背景

•介绍当前已知的相关算法。

•各算法的优缺点。

•复杂度分析等。

•本模块选择的算法和原因。

（2）原理

•给出本算法的出处，引文或专利。

•提炼岀本算法的原理，最好用数学方式来描述（如公式，图标等）。

（3）处理流程

•使用流程图等方法，一步一步说明本算法的处理过程。

•要求详细，明确。

（4）参数说明

•详细说明算法中，处理过程中所用到的参数等等。

•给出本模块所支持的参数范囤，大小，以及各种参数组合。

•推荐使用的参数组合，以及适用环境。

（5）性能说明

-~•给出理论和仿真性能。

4.3子模块2设计

4.4子模块n设计

5・运行设计

5.1运行模块组合

说明对系统施加不同的外界运行控制时，所引起的％种不同的运行模块组合。

说明每种运行所历经的内部模块和支持软件。

5.2运行控制

说明每一种外界的运行控制的方式方法和操作步骤。

5.3运行时间

说明每种运行模块组合将占用各种资源的时间。

6.系统数据结构设计

6.1逻辑结构设计要点

给出本系统内所使用的每个数拯结构的名称、标识符以及它们之中每个数搦项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。

6.2物理结构设计要点

给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。

说明各个数据结构与访问这些数据结构的形式。

用一览表的方式说明每种可能的岀错或故障情况出现时，系统输出信息的形式、含义及处理方法。

7.测试方案

7.1系统测试方案

从系统的角度对整个系统如何测试进行说明。

7.1.1测试设计说明

给出具体的测试方法、流程图、框图等。

7.1.2测试内容

包括系统测试对象、测试数据等相关内容。

7.2模块测试方案

将系统分成多个子模块，分别测试各个子模块。

7.2.1测试设计说明

7.2.2测试内容

包括各个模块测试对象、测试数据等相关内容。

7.3存在的问题

给出上述测试方案所存在的问题，对系统功能测试有哪些不足。