设计文档编写规范

德信诚培训网

更多免费资料下载请进： 好好学习社区

设计文档编写规范

一.项目立项文档编写规范

(一)规范文档清单

① 立项申请报告

② 可行性研究报告

③ 可行性研究评审报告

④ 产品规格说明书

(二)规范文档内容

(1)立项申请报告

本文档用来说明开发项目的主要内容和达到的目标〈主要技术指标〉、经费概算及计划完成时间等。具体编写内容如下:

关键词:

摘要:

缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。

参考资料:列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。

1.引言

2.项目名称、型号、项目来源、承担部门

3.项目的根据及必要性

4.国内外技术水平比较和发展趋势

5.开发项目的目标和主要技术指标

6.研究方向的选择或初步设想的方案和主要技术途径

7.需要解决的重大关键技术问题

8.工业标准化技术或产品以及公司内成熟技术或产品的利用情况

9.关键器材、设备及必要条件

10.经济合理性分析和经费

11.研究进度(起止时间) 德信诚培训网

更多免费资料下载请进： 好好学习社区 12.成果形式

13.项目负责人及主要成员

14.其它

15.评审报告

预审意见:

1.研究方向与公司发展领域的一致性

2.关键技术的可实现性

3.工业标准化技术或产品以及公司内成熟技术或产品的利用率

4.进度、经费合理性

5.结论及应采用的开发策略

6.审核者姓名，职务或职称及日期

7.其它

(2)可行性研究报告

本文档主要论证开发项目在技术上和经济上实现的可行性、市场可行性以及专利可行性。具体编写内容如下：

关键词：

摘要：

缩略语说明：

参考资料：

1.引言

2.开发目标

3.功能、性能及主要技术指标

4.国内外现状及发展趋势，分析可能的替代技术或产品所引发的产品生命周期问题。

5.技术可行性分析

技术可行性分析可包括以下内容：

 技术关键

 技术途径

现有公司的技术条件及可供利用共享的程度，可利用合作资源及知识产权现状。 德信诚培训网

更多免费资料下载请进： 好好学习社区  试用方法

 风险分析

 现有测试条件及设备条件

6.市场可行性分析

 产品在国内外的销售数量

 市场预测的调查和估计

 竞争对手情况分析

7.人力资源需求情况

分阶段提出产品开发各阶段所需各类人员

8.经济可行性分析

经济可行性分析可包括以下内容：

 经济效益估计，包含整个估计的产品生命周期

 现有研究设备情况

 研究成本估计

包括仪器设备费、样机材料费、对外合作费用、产品产生效益后的在开发费用、产品维护等费用及其它人力费用。

9.专利可行性分析

 专利情报检索、分析（国内、国外）

 科技情报及对手技术分析

 专利申请策略

 制定专利技术合作、许可、借鉴、策略

10.阶段计划

确定各阶段的分目标 研究内容及成果形式

11.详细计划和成果形式

详细计划的安排及落实措施，预计进行哪种鉴定。

12.对外合作单位情况和分工意见

包括以下内容：

 对外合作的单位名称

 合作单位的实力分析

 委托项目及完成日期 德信诚培训网

更多免费资料下载请进： 好好学习社区  备注

13.其它

(3)可行性研究评审报告

可行性研究评审报告是按立项申请报告的要求，对可行性研究报告中关于开发项目的技术可行性、经济可行性、市场可行性、专利可行性和人员需求情况的审查核实和评议，最后提出的可行性研究评审报告。具体编写内容如下:

关键词:

摘要:

缩略语说明:

参考资料:

1.引言

2.开发项目名称、项目代码及型号

3.系统的开发目标、功能、性能和主要技术指标

4.可行性评审内容

4.1技术可行性评审

 技术关键

 技术途径

 现有公司的技术条件

 试验方法

 风险分析

 测试条件及设备条件

4.2经济可行性评审

 经济效益评估

 现有开发环境和设备

 研究成本估算

4.3市场可行性评估

 销售数量

 市场预测

 竞争对手状况 德信诚培训网

更多免费资料下载请进： 好好学习社区 4.4专利可行性评审

 国外专利状况(借鉴利用)

 国内专利状况(合作、许可)

 主要竞争对手技术现状评估

 专利申请策略

5.人员需求情况评审

研究小组核心成员能否到位，人员需求合理性。

6.结论

经过对可行性报告逐项评审后，编写可行性评审报告，除对可行性报告中的准确性给予结论意见外，若有不够之处，还可提出改进意见或存在问题，以利修改。给出应采用的开发策略。

7.评审者姓名，职务或职称及日期。

8.其它

(4)产品规格说明书

产品规格说明书是对产品用途、性能、结构特征、基本工作原理和使用等说明，具体编写内容如下:

关键词:

摘要:

缩略语说明:

参考资料:

1.引言

2.产品的名称和型号

3.用途、性能及使用要求

简述产品用途和性能，详细说明产品的使用要求(环境条件、注意事项等等)。

4.技术参数

5.基本工作原理

按本产品的使用要求，以通俗易懂的文字和必要的图样、略图、简要说明产品的基本工作原理。

6.结构特征 德信诚培训网

更多免费资料下载请进： 好好学习社区 简要说明本产品的结构特征(如外形尺寸、安装只寸等)可用外形图、安装图及有关图形符号等表明其主要的结构情况和功能原理。

7.应用指南

对本产品的应用环境和应用方法以及可能的配置及配套情况作全面描述，并举例说明

8.其它

二．总体方案书编写规范

关键词:

摘要:

缩略语说明:

参考资料:

1.引言

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)软件需求规格说明书

关键词：

摘要：

缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。

参考资料：列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。 德信诚培训网

更多免费资料下载请进： 好好学习社区 1.引言

1.l背景

A.用一个名字标识要开发的软件产品。

B.说明软件产品的用途。

1.2参考资料

2.概述

2.1产品的描述

2.1.1如果被开发软件是独立的，则应在本节描述被开发软件概况。

2.1.2如果本软件系统是一个较大的系统或项目中的一个组成部分，那么概述这个较大的系统或项目的每一个组成部分的功能，并标识其接口；标识被开发软件的主要外部接口。用图形表达其主要组成、相互联系和外部接口是非常直观的。

2.2产品的功能

简明叙述被开发软件的功能。内容可以直接从较高层次的规格说明中引用。

2.3开发环境

列出所采用的操作系统、编程语言、编程工具(编译器和调试器)、数据库平台和网络平台。

2.4一般约束

A.硬件的限制

B.与其他应用系统的接口

3.具体需求

3.1功能需求

描述软件产品的输入经过什么处理转换为输出，必须描述在软件中进行的基本操作。对于每一类功能或者对于每一个功能，需要描述其输入、处理和输出等需求。

3.1.1功能需求1

3.1.1.1引言

描述完成本功能的目的、所使用的方法和技术，还应当包括可以清楚说明本功能意图的来源或背景材料。

3.1.1.2输入