设计文档编写规范一.项目立项文档编写规范(一)规范文档清单①立项申请报告②可行性研究报告③可行性研究评审报告④产品规格说明书(二)规范文档内容(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功能需求13.1.1.1引言描述完成本功能的目的、所使用的方法和技术，还应当包括可以清楚说明本功能意图的来源或背景材料。
3.1.1.2输入A.对本功能全部输入数据的详细描述，它们包括输入源、数量、度量单位、时间关系、有效输入的范围、精度和公差。
B.操作员具体的控制需求，其中包括操作员活动的描述，控制台或操作员的位置等。
C.指明引用的接口规格说明或相应的接口控制文档。
3.1.1.3输出A.输出的目的地；B.有效输出的范围、精度和公差；C.非法值的处理；D.错误信息。
3.l.2功能需求23.1.N功能需求N3.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其它需求由于软件的类型、用户组织的特点等，某些特殊的需求可在下面描述。
3.6.1故障处理列出可能发生的软件和硬件故障，并指出这些故障对各项性能指标所产生的影响以及对故障处理的要求。
(2)软件概要设计说明书关键词：摘要：缩略语说明：参考资料：1.引言A.待开发软件系统名称。
B.该系统基本概念，如该系统的类型、从属地位等。
D.项目代号。
2.总体设计2.1系统描述2.1.1需求规定对所开发软件的概要描述，包括主要的输入/输出、主要功能、性能等。
2.1.2运行环境规定描述本系统赖于运行的硬件、软件环境2.2总体设计说明2.2.1基本设计概述列出在描述、说明总体设计时要用到的一些基本概念，给出其解释说明。
2.2.2设计思想阐述在进行总体设计时的基本考虑。
结合设计限制，说明如何根据这些设计限制进行综合考虑后而建立起目标系统的总体结构及功能划分；亦可将所考虑过的多个总体设计作对比分析，说明选择当前总体结构的原因。
2.3系统结构和处理流程2.3.1系统结构用框图形式说明目标系统的模块划分，扼要说明每个模块的标识符和功能，分层次地给出各元素之间的控制与被控制关系。