设计文档编写规范docWord格式文档下载.docx
《设计文档编写规范docWord格式文档下载.docx》由会员分享，可在线阅读，更多相关《设计文档编写规范docWord格式文档下载.docx（37页珍藏版）》请在冰豆网上搜索。
现有测试条件及设备条件
6.市场可行性分析
产品在国内外的销售数量市场预测的调查和估计
竞争对手情况分析
7•人力资源需求情况
分阶段提出产品开发各阶段所需各类人员
8•经济可行性分析
经济可行性分析可包括以下内容：
经济效益估计，包含整个估计的产品生命周期现有研究设备情况
研究成本估计
包括仪器设备费、样机材料费、对外合作费用、产品产生效益后的在开发费用、产品维护等费用及其它人力费用。
9•专利可行性分析
专利情报检索、分析（国内、国外）
科技情报及对手技术分析
专利申请策略
制定专利技术合作、许可、借鉴、策略
10•阶段计划
确足各阶段的分目标研究内容及成果形式
11•详细计划和成果形式
详细计划的安排及落实措施，预计进行哪种鉴定。
12.对外合作单位情况和分工意见
包括以下内容：
对外合作的单位名称
合作单位的实力分析
委托项目及完成日期
备注
13•其它
（3）可行性研究评审报告
可行性研究评审报告是按立项申请报告的要求，对可行性研究报告中关于开发
项目的技术可行性、经济可行性、市场可行性、专利可行性和人员需求情况的审查
核实和评议，最后提出的可行性研究评审报告。
具体编写内容如下：
2•开发项目名称、项目代码及型号
3•系统的开发目标、功能、性能和主要技术指标
4•可行性评审内容
4.1技术可行性评审
现有公司的技术条件
试验方法
测试条件及设备条件
4.2经济可行性评审
经济效益评估
现有开发环境和设备
研究成本估算
4.3市场可行性评估
销售数量
市场预测
竞争对手状况
4.4专利可行性评审
国外专利状况（借鉴利用）
国内专利状况（合作、许可）
主要竞争对手技术现状评估
5.人员需求情况评审研究小组核心成员能否到位，人员需求合理性。
6•结论
经过对可行性报告逐项评审后，编写可行性评审报告，除对可行性报告中的准确性给予结论意见外，若有不够之处，还可提出改进意见或存在问题，以利修改。
给出应采用的开发策略。
7•评审者姓名，职务或职称及日期。
8•其它
⑷产品规格说明书
产品规格说明书是对产品用途、性能、结构特征、基本工作原理和使用等说明，具体编写内容如下：
2.产品的名称和烈号
3•用途、性能及使用要求
简述产品用途和性能，详细说明产品的使用要求（环境条件、注意事项等等）o
4.技术参数
5•基本工作原理
按本产品的使用要求，以通俗易懂的文字和必要的图样、略图、简要说明产品的基本工作原理。
6.结构特征
简要说明本产品的结构特征（如外形尺寸、安装只寸等）可用外形图、安装图及有关图形符号等表明其主要的结构情况和功能原理。
7•应用指南
对本产品的应用环境和应用方法以及可能的配置及配套情况作全面描述，并举例说明
二•总体方案书编写规范
2•概述
2.1系统描述
2.2系统功能
2.3开发环境
2.4一般约束
3.系统需求
3.1需求分析
3.2格式要求
3.3功能需求
3.4外部接口需求
3.4.1用户界面
3.4.2硬件接口
3.4.3软件接口
3.4.4通讯接口
3.5性能需求
3.5.1静态数值需求
3.5.2动态数值需求
3.6属性需求
3.6.1可靠性
3.6.2
安全性
3.6.3
可维护性
3.6.4
可移植性
3.6.5
兼容性
3.6.6
可配置性
3.6.7
系统升级
3.6.8属性需求
4•其它
三.软件设计文档编写规范
1软件需求规格说明书
2软件概要设计说明书
3软件详细设计说明书
4通讯协议说明书
5函数调用协议说明书
6软件测试方案
7软件测试报告
（1）软件需求规格说明书
列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。
列出本文档所引用的参考资料的名称、作者、标题、编号、岀版日期、出版单位。
1.1背景
A.用一个名字标识要开发的软件产品。
B.说明软件产品的用途。
1.2参考资料
2.1产品的描述
2.1.1如果被开发软件是独立的，则应在本节描述被开发软件概况。
2.1.2如果本软件系统是一个较大的系统或项目中的一个组成部分，那么概
述这个较大的系统或项目的每一个组成部分的功能，并标识其接口；
标识被开发软件的主要外部接口。
用图形表达其主要组成、相互联系和外部接口是非常直观的。
2.2产品的功能
简明叙述被开发软件的功能。
内容町以直接从较高层次的规格说明中引用。
列出所采用的操作系统、编程语言、编程工具（编译器和调试器）、数据库
平台和网络平台。
A・硬件的限制
B.与其他应用系统的接口
3.具体需求
3.1功能需求
描述软件产品的输入经过什么处理转换为输出，必须描述在软件中进行的基本操作。
对于每一类功能或者对于每一个功能，需要描述其输入、处理和输出等需求。
3.1.1功能需求1
3.1.1.1引言
描述完成本功能的目的、所使用的方法和技术，还应当包括可以清楚说明本功能意图的来源或背景材料。
3.1.1.2输入
A•对本功能全部输入数据的详细描述，它们包括输入源、数量、度量单位、时间关系、有效输入的范围、精度和公差。
B.操作员具体的控制需求，其中包括操作员活动的描述，控制台或操作员的位置等。
C.指明引用的接口规格说明或相应的接口控制文档。
3.1.1.3输出
A・输出的目的地；
B.有效输出的范围、精度和公差；
C.非法值的处理；
D.错误信息。
3.12功能需求2
3.1.N功能需求N
3.2外部接口需求
3.2.1用户界面
A.用户使用软件产品时的界面需求。
例如，如果系统的用户通过显示终端操作，就必须指定如下需求：
对屏幕格式的要求，报表或菜单的页面显示格式和内容，有关输入和输出的时间，用户命令的形式；
B.界面的优化问题。
可以简单地用一个表列出系统用户做什么或不做什
么。
例如，要求的是长的还是短的出错信息。
与其他需求一样，这种需求也应该是可验证的。
3.2.2硬件接口
陈述软件产品与系统硕件设备之间每一个接口的逻辑特点。
还可能包括如
下事宜：
要支持什么样的设备，如何支持这些设备，如何约定。
3.2.3软件接口
陈述其它有关软件（如数据库管理系统、操作系统、或者数学软件包）的使
用方法，以及同其它相连接软件的接口。
对每一个有关的软件产品，应该提供如下内容：
A.名字
B.助记符
C•版本号
对于每个与其它软件的接口，本部分应：
A.描述在与本软件产品相连接的软件的基本功能，以及达到的目的。
B.描述传递信息的内容、格式和接口定义。
对于己有完整文档的接口，只
需要引用描述该接口的文档。
3.2.4通讯接口
说明各种通讯接口。
例如局部网络协议等。
3.3性能需求
从整体上说明对该软件、或人与该软件相互作用的静态或动态数值需求。
3.3.1静态数值需求包括
A•支持的终端数
B.支持的同时操作的用户数
C・处理的文件和记录数
D.表和文件的大小
E.对数据的精度要求，包括数学的、逻辑的和传输的精度等。
3.3.2动态数值需求可以包括诸如处理和任务的数量，以及在正常情况下和峰值工作条件下，在一定时间周期中要处理的数据总数。
有关响应时间、更新处理时间、数据转换和传输时间也在这一部分陈述。
3.4设计约束
说明需遵守的其它标准和硬件限制等设计约束。
3.4.1需遵守的其它标准
A・报表格式
B.数据命名
C.检查追踪
3.4.2硬件限制
描述各种影响或约束软件产品的硕件成分，应包括：
A.硬件配置的特点（接口数，指令系统等）；
B.主存贮器和辅助存贮器的容量；
C.CPU速度。
3.5属性需求
在软件的具体需求中可以有若干属性。
3.5.1可靠性
3.5.2安全性
指出保护软件的要求，以防止突然或非法的访问、使用、修改或者泄密。
3.5.3可维护性
指定若干需求，以确保软件是可维护的。
3.5.4可移植性
列岀确保用户程序和用户界面兼容方面的需求，以及为把被开发软件从一
种运行环境移植到另一个运行环境的需求等。
3.6其它需求
由于软件的类型、用户组织的特点等，某些特殊的需求可在下面描述。
列出可能发生的软件和硕件故障，并指出这些故障对各项性能指标所产生的影响以及对故障处理的要求。
⑵软件概要设计说明书
A•待开发软件系统名称。
B.该系统基本概念，如该系统的类型、从属地位等。
D.项目代号。
2.总体设计
2.1.1需求规定
对所开发软件的概要描述，包括主要的输入/输出、主要功能、性能等。
2.1.2运行环境规定
描述本系统赖于运行的硕件、软件环境
2.2总体设计说明
2.2.1基本设计概述
列出在描述、说明总体设计时要用到的一些基本概念，给出其解释说明。
2.2.2设计思想
阐述在进行总体设计时的基本考虑。
结合设计限制，说明如何根据这些设计限制进行综合考虑后而建立起目标系统的总体结构及功能划分；
亦可将所考虑过的多个总体设计作对比分析，说明选择当前总体结构的原因。
2.3系统结构和处理流程
2.3.1系统结构
用框图形式说明目标系统的模块划分，扼要说明每个模块的标识符和功能,分层次地给出各元素之间的控制与被控制关系。
3•接口设计
3.1.1用户接口
列出系统将向用户提供的操作命令、功能说明和用法描述，系统的响应信息及其含义。
3.1.2硬件接口
说明本系统的硬件接口的设计安排。
3.1.3软件接口
说明本系统的软件接口的设计安排。
3.1.4通讯接口
说明本系统的通讯接口的设计安排。
3.2内部接口
说明本系统内各功能模块间的接口设计。
4.属性设计
说明系统对以下三个方面的属性所作的特殊设计和考虑。
4.1可靠性
4.2安全性
4.3可维护性
5.系统数据结构
5.1逻辑结构设计要点
说明系统主要数据的逻辑结构，包括定义、存储要求、一致性约束条件等。
5.2数据结构与模块的关系
可采用矩阵图形式，并规定以下符号
C创建U更新R读出使用
6.运行设计
说明对系统运行时的顺序、控制、时间等的设计安排。
7•系统出错处理
7.1出错类别
对系统对可能出现的某些错误和故障作了专门的设计考虑，并给出这些错误或故障的定义。
7.2出错处理
说明将使用的恢复或再启动技术，使软件从故障点恢复执行或软件从头开始重新运行的方法。
8.开发环境
8.1硕件环境
列出开发本系统所需要的硕件平台、工具等。
8.2软件环境
列出开发本系统所需要的软件平台，如操作系统、数据库、网络平台、软件辅助工具及使用周期等。
9.系统调试与测试方法
9.1调试方法
说明系统调试的环境、工具，应观察的结果等。
9.2测试方法
说明集成测试的方法（从下而上或从上而下）、模块测试的顺序，给出辅助模块、驱动模块及测试用例，说明这些测试用例的选取原则。
（3）软件详细设计说明书
1.引言
说明是哪个系统或何种系统的哪个模块的软件详细设计说明书。
2.设计思想
阐述在进行设计时的基本考虑。
结合设计限制，说明如何根据这些设计限制
进行综合考虑后而建立起目标系统的结构及功能划分；
亦可将所考虑过的多个设计作对比分析，说明选择当前结构的原因。
3.软件结构
详细描述其功能，若是模块，应描述它所处的大系统中的位置、与系统的关系及相关模块的关系。
3.2子模块划分
用图形说明本系统（或模块）的实现，即系统内部的子模块划分。
3.3子模块间关系
说明各子模块间的控制、顺序等藕合关系。
4.公共数据结构
给出本系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型泄义、初始取值、可能取值的范围及相应的物理含义。
建议以类似C语言的数据说明格式来描述。
5•程序1
5.1输入
详细说明本程序的输入参数，包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。
5.2输出
详细说明本程序的输出参数，包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。
5.3返回
说明返回值的含义
6.程序2
N.程序ni黠构与5相同）
@）通讯协议说明书
说明本文档所属的软件项目名称。
1・2硕件环境
用图形方式描述通讯双方的硬件环境构成及通讯物理链路。
1.3功能说明
简述通讯双方各自的功能，说明通讯目的。
2•通讯协议
2.1命令格式
含发命令格式及收命令格式，说明每一项的数据类型和含义。
2.2命令描述
说明每一种命令的具体格式、含义及要求的应答格式，该部分内容的编写要依据各自的特点编写。
例如可分类描述，若有命令码编写规则要专门描述，描述的原则是清晰、完整、易懂。
（5）函数调用协议说明书
1•引言
11背景
说明本文档属于哪个软件项目。
1.2硕件环境
简述通讯双方各自的功能，说明通讯的可靠性及速率要求。
2.函数调用说明
（6）系统对接联调说明书
1引言
1.1
编写目的
1.2
用途
1.3
参与对接联调的人员名单
1.4
对接联调起始时间
2用户系统
3本系统设备配置
5对接安装步骤
6发现的问题
7适应性修改
8改进建议
（7）软件测试计划
1・测试计划名称
为本测试计划书定义一个专用名称。
2•引言
归纳所要求测试的软件项和软件特性，可以包括系统目标、背景、范围及引用材料等。
在最高层测试计划书中，如果存在下述文件，则需要引用它们：
项冃计划、质量保证计划、有关的政策、有关的标准等。
3.测试项
描述被测试的对象，包括其版本、修订级别，并指出在测试开始之前对逻辑或物理变换的要求。
4.被测试的特性
指明所有要被测试的软件特性及其组合，指明每个特性或特性组合有关的测试设计说明。
5.不被测试的特性
指出不被测试的所有特性和特性的有意义的组合及其理由。
6•方法
描述测试的总体方法，规定测试指定特性组所需的主要活动、技术和工具,应详尽地描述方法，以便列出主要的测试任务，并估计执行各项任务所需的时间。
规定所希望的最低程度的测试彻底性，指明用于判断测试彻底性的技术
（如：
检查哪些语句至少执行过一次）。
指出对测试的主要限制，例如：
测试项町用性、测试资源的可用性和测试截止期限等。
7.测试项通过准则
各测试项通过测试的标准。
8•暂停标准和再启动要求
规定用于暂停全部或部分与本计划有关的测试项的测试活动的标准，规定当测试再启动时必须重复的测试活动。
9•应提供的测试文件
规定测试完成后所应递交的文件，这些文件可以是前述文件的全部或者部分。
10•测试任务
指明执行测试所需的任务集合，指出任务间的一切依赖关系和所需的一切
特殊技能。
11•环境要求
规沱测试环境所必备的和希望有的性质，其中包括硬件、通信和系统软件的物理特征、使用方式以及任何其它支撑测试所需的软件或设备，指出所需的特殊测试工具及其它测试要求，指出测试组目前还不能得到的所有要求的来源。
12•职责
指出负责管理、设计、准备、执行、监督、检查和仲裁的小组，指出负责
提供测试项和提供测试环境的小组。
这些小组可包括开发人员、测试人员、操作员和质量保证人员。
13•人员和训练要求
指明测试人员应有的水平以及为掌握必要技能可供选择的训练科目。
14•进度
在软件项目进度中规加的测试起点以及所有测试项传递时间。
定义所需的新的测试起点，估计完成每项测试任务所需的时间，为每项测试任务规定进度，对每项测试资源规定使用期限。
（8）软件测试报告
参考资料
1.测试任务名称和内容
2.模块功能概述
3•测试项目
3.1测试项目一
3.1.1
目的
3.1.2
测试环境与版本
3.1.3
输入
3.1.4
预期结果
3.1.5
实际结果
3.1.6
异常现象及分析
3.1.7
环境影响分析
3.1.8
测试人员和日期
3.1.9
重复执行结果
3.2测试项目二
3.N测试项目N
4•测试充分性评价
5.结果分析
6.测试结论
四•硕件设计文档编写规范
（一）规范文档清单
1硬件需求规格说明书
2硬件概要设计说明书
3单板硬件概要设计说明书
4单板硬件详细设计说明书
5单板软件详细设计说明书
6单板硬件过程调试报告
7单板软件过程调试报告
8单板硬件测试报告
9硬件系统联调报告
（-）规范文档内容
（1）硬件需求规格说明书
硬件需求规格说明书是描写硬件设计目标、基本功能、基本配置、主要性能
指标、运行环境、约束条件以及开发经费和进度等要求，它的基本依据是《产品
需求规格说明书》及《总体方案书》。
它是硬件总体设计和制订硬件开发计划的依
据。
列出本文档中用到的所有非通用的缩写与略语的全称、专门术语
的定义
列出本文档所引用的参考资料的名称、作者、标题、编号、出版日
2•开发项目的名称和型号
3.系统历史及修改说明
4.基本配置
5.运行环境
6.硕件整体系统的基本功能和主要性能指标
7.硬件分系统的基本功能和主要性能指标
8.功能模块的划分
9.关键技术的攻关
10•外购硬件的名称、型号、生产单位、主要技术指标
11・主要仪器设备
12•国内外同类产品的技术介绍
13•开发经费
14.开发进度及文档计划
15•其它
⑵硬件概要设计说明书
《硬件概要设计说明书》是根据《需求规格说明书》、《总体方案书》及《硬
件需求规格说明书》的要求进行设计后编制的报告，它是硬件详细设计的依据，
I.引言
4.功能及主要性能指标
5.系统总体结构图及功能划分
6.单板命名
7.系统逻辑框图
8•组成系统各功能块的逻辑框图、电路结构图及单板组成
9•单板逻辑框图和电路结构图
10.关键技术讨论
II.关键器件
12•可靠性、安全性、电磁兼容性讨论
13.电源设计
14.工艺、结构设计初步
15•包装设计
15•硬件联调测试方案
16.其他
（3）单板硬件概要设计说明书
1•概述
2•单板版本号、单板在整机中的位置、开发目的及主要功能
3•单板功能描述、单板尺寸（单位）
4.单板逻辑框图及各功能模块说明
5.单板软件功能描述
6.单板软件功能模块划分
7•接口简单定义、与相关板的关系
8•指标（主要性能指标、功耗、采用标准）
9•开发仪表、仪器
10•其他
⑷单板软件概要设计说明书
1・概述
1.2编程语言、编译器和调试环境
2•总体设计
2.1硕件说明
2.2功能
2.3存贮区分配
2.4数据结构
2.5软件功能设计细节与要求
2.6相关通讯协议
⑸单板硬件详细设计说明书
1•概述
2.单板历史及修改说明
3•逻辑框图及各功能模块详细说明、各功能模块实现方式
4•地址分配、控制方式、接口方式、存贮器空间、中断方式
5•接口管脚信号详细定义、时序说明、性能指标
6•指示灯说明
7•外接线定义（母板跳线、DIP开关、电源保险）
8•可编程器件图、功能模块说明、相关时序图
9.原理图设计
10.PCB图设计
11・详细物料清单
12.PCB板工艺、结构设计说明
13•单板测试、调试计划（技术）
（6）单板软件详细设计说明书
（1）背景
说明所属项目名称、编号及相应硬件单板版本名称、版本历史修改说明。
（2）编程语言、编译器和调试环境
2•硕件描述与功能要求
（1）cpu类型
（2）RAM说明
（3）R0M说明
（4）控制灯和DIP开关功能说明
（1）单板功能
⑵软件功能
2.3数据结构
（1）存贮区分配
（2）逻辑结构
（3）物理结构
⑷配置数据
2.4设计细节
2.4.1中断
含中断级别与中断处理等内容
2.4.2程序流程（或状态迁移）
2.4.2.1主程序
升级会员 