需求分析、概要设计、详细设计的标准格式

需求分析，概要设计，详细设计的标准格式一、开发计划（一）引言1、目的说明编制开发计划的目的。2、参考资料列出必要的参考资料。3、定义列出用到的术语的定义和外文缩写的原文。（二）概述1、工作内容2、主要参加人员3、成果列出要提交给用户的程序文件、文档或服务的名称，及非移交成果的名称。4、完成的最迟期限（三）实施计划1、任务的分解及人员分工列出各项任务及其负责人和主要参加人员。2、进度列出各任务的开始日期和完成日期。3、关键问题列出影响整个开发项目的关键问题，技术难度、风险及处理方案。（四）支持条件1、计算机系统支持2、需要由用户承担二、需求分析说明书（一）引言1、目的说明编制需求分析说明书的目的。2、参考资料列出必要的参考资料。3、定义列出用到的术语的定义和外文缩写的原文。（二）概述1、目标说明本项软件开发意图、应用目标、作用范围等，以及所开发的软件与其它软件的关系。2、用户特点列出使用本软件的用户类型、特点、其教育程度和技术特长。3、约束和假定列出本软件开发工作的假定和约束。（三）需求规定1、对功能的规定根据功能模型逐项说明本软件各项功能的详细需求。列出完成各项功能所需输入，处理，输出及所需控制等。2、对性能的规定包括精度、时间特性要求、灵活性。3、数据要求数据分为静态数据和动态数据两类。静态数据是指在程序运行过程中一般不改变的数据；动态数据是指在运行中发生变化、需要输入输出的数据。（1）数据描述（2）数据采集（3）输入输出要求（4）其它要求（四）运行环境规定（1）硬件包括处理机、网络、输入输出设备及其它设备。（2）软件列出支持软件。（3）接口包括必要的硬件接口、软件接口、通讯接口等。（五）关于不可能实现的用户要求的说明三、概要设计说明书（一）引言1、目的说明编制概要设计说明书目的。2、参考资料列出必要的参考资料。3、定义列出用到的术语的定义和外文缩写的原文。（二）总体设计1、需求规定简述本系统的主要功能、性能等要求。详见需求分析说明书。2、运行环境简述本系统的运行环境规定。详见需求分析说明书。3、基本设计思路可以用图表、文字来表达概要设计的基本思路。4、数据结构设计5、接口设计（1）用户接口（2）外部接口说明本软件与其它软件的所有接口说明。（3）内部接口说明本软件系统中各个系统元素间的接口安排。6、系统可扩展性设计说明为了系统扩展所做的设计安排。7、系统维护设计8、出错处理设计包括出错信息和处理方法。四、详细设计说明书（一）引言1、目的说明编制详细设计说明书的目的。2、参考资料列出必要的参考资料。3、定义列出用到的术语的定义和外文缩写的原文。4、约定指出本说明书及编码的命名约定。（二）软件的组织结构可以用图、表和文字来表达软件系统的组织结构。（三）模块设计说明对每个模块设计进行说明，格式如下：1、描述描述模块的特点、功能和性能要求。2、输入参数列出每一输入参数的名称、意义、数据类型和格式、有效范围、输入方式、输入介质和输入数据的来源等。3、输出参数列出每一输出参数的名称、意义、数据类型和格式、有效范围、输入方式、输出图形及符号的说明等。4、接口（1）说明本模块的调用方法，列出本模块调用的其它模块名、参数、调用方式。（2）列出与本模块直接关联的数据结构、数据库及数据文件。5、算法6、程序逻辑可以用PDL、图、表来描述。7、存储分配8、限制条件9、测试计划10、尚未解决的问题列出本模块未解决，但在软件完成前必须解决的问题。五、用户手册（一）引言1、目的说明编写用户手册的目的。2、参考资料列出必要的参考资料，如：本项目的经核准的计划任务书、合同或上级机关的批文属于本项目的其它已发表的文件、本文件中各处引用的文件资料、包括软件开发标准等，列出资料的标题、文件编号、发表日期、出版单位、必要时说明如何得到这些资料。3、定义列出本文件中用到的术语的定义和外文缩写的原文。（二）用途概述本软件系统的功能、性能及其它各项特点，使用范围。（三）运行环境1、硬设备列出运行本软件所需硬件的最少配置及最大配置，如：·处理机，包括客户机及服务器，型号、内外存容量等。·网络·输入输出及其它专用设备2、支持软件列出支持软件3、数据列出支持本软件运行所需要的数据库或数据文件（四）使用规程说明程序的存储形式、安装及初始过程中全部操作命令、系统对这些命令的反应及答复、表示安装工作完成的测试实例等、及安装过程中使用的专用软件。（五）使用过程详细列出用户使用每个界面的形式，使用菜单、按钮、鼠标、键盘输入等操作方式的含义及相应屏幕响应结果。（六）出错处理和恢复列出软件产生的出错信息及产生条件，指出为了确保再启动和恢复用户必须遵循的处理方法。六、测试计划（一）引言1、目的说明本文档编写目的，计预期读者。2、参考资料列出必要的参考资料，如：本项目的经核准的计划任务书、合同或上级机关的批文属于本项目的其它已发表的文件。本文件中各处引用的文件资料、包括软件开发标准等，列出资料的标题、文件编号、发表日期、出版单位、必要时说明如何得到这些资料。3、定义列出本文件中用到的专门术语的定义和外文缩写的原文。（二）计划1、测试内容列出每一项测试的目的、内容、进度安排、及不能测试的内容。2、测试1条件：列出对资源的要求。测试方法：说明采用何种方法进行测试设计。人员：参加测试工作的人员。3、测试2……（三）测试设计1、测试1说明第一次测试内容的设计考虑，包括数据准备及执行。（1）控制：说明本测试的控制方式，如输入是人工，或半自动，或自动进行。（2）输入：测试中输入的数据。（3）预期输出结果。（4）过程：测试过程中的步骤。（四）评价1、范围测试用例能检查的范围。2、数据整理方法。3、尺度说明测试工作是否能够通过评价尺度。如：合理的输出结果类型与预期结果允许偏离的范围，允许中断或停机的次数等。七、测试报告（一）引言1、目的说明本文档编写目的。2、参考资料列出必要的参考资料，如：本项目的经核准的计划任务书、合同或上级机关的批文属于本项目的其它已发表的文件。本文件中各处引用的文件资料、包括软件开发标准等，列出资料的标题、文件编号、发表日期、出版单位、必要时说明如何得到这些资料。3、定义列出本文件中用到的专门术语的定义和外文缩写的原文。（二）测试概要用表格列出每一项测试的内容，测试结果（三）测试结果及发现测试1：测试2：……（四）结论1、能力说明系统的能力2、缺陷和限制3、评价4、资源消耗