软件工程项目文档模板.doc

1、 软件工程项目文档模板一、可行性研究报告可行性研究报告(ISO 标准)编者说明：在立项时，应该对项目进行综合分析，探讨项目的经济、社会、技术可行性，从而为决策提供基础。该模板为 ISO 标准文档模板，其不仅适用于软件项目，对于其它的系统项目也适用。1引言1.1 编写目的编写本可行性研究报告的目的，指出预期的读者。1.2 背景a.所建议开发的软件系统的名称；b.本项目的任务提出者、开发者、用户及实现该软件的计算站或计算机网络；c.该软件系统同其他系统或其他机构的基本的相互来往关系。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出用得着的参考资料。 2可行

2、性研究的前提说明对所建议开发的软件的项目进行可行性研究的前提。2.1 要求说明对所建议开发的软件的基本要求。 2.2 目标说明所建议系统的主要开发目标。 2.3 条件、假定和限制说明对这项开发中给出的条件、假定和所受到期的限制。2.4 进行可行性研究的方法说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的，摘要说明所使用的基本方法和策略。2.5 评价尺度说明对系统进行评价时所使用的主要尺度。 3对现有系统的分析这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要

3、性。3.1 处理流程和数据流程说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示，并加以叙述。3.2 工作负荷列出现有系统所承担的工作及工作量。 3.3 费用开支列出由于运行现有系统所引起的费用开支。 3.4 人员列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。3.5 设备列出现有系统所使用的各种设备。 3.6 局限性列出本系统的主要局限性。 4所建议的系统4.1 对所建议系统的说明概括地说明所建议系统，并说明在第 2 条中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。4.2 处理流程和数据流程。给出所建议系统的处理流程式和数据流程。 4.3

4、 改进之处按 2.2 条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。4.4 影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。4.4.1.对设备的影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改4.4.2.对软件的影响说明为了使现存的应用软件和支持软件能够同所建议系统相适应，而需要对这些软件所进行的修改和补充。4.4.3.对用户单位机构的影响说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。4.4.4.对系统运行过程的影响说明所建议系统对运行过程的影响。4.4.5.对开发的影响说明对开发的影响。4.4.6.对地点和

5、设施的影响说明对建筑物改造的要求及对环境设施的要求。4.4.7.对经费开支的影响扼要说明为了所建议系统的开发，统计和维持运行而需要的各项经费开支。4.5 技术条件方面的可能性本节应说明技术条件方面的可能性5可选择的其他系统方案扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。5.1 可选择的系统方案 1说明可选择的系统方案 1，并说明它末被选中的理由。5.2 可选择的系统方案 2按类似 5。1 条的方式说明第 2 个乃至第 n 个可选择的系统方案。6投资及效益分析6.1 支出对于所选择的方案，说明所需的费用，如果已有一

6、个现存系统，则包括该系统继续运行期间所需的费用。6.1.1 基本建设投资包括采购、开发和安装所需的费用。6.1.2 其他一次性支出 6.1.3 非一次性支出列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用。6.2 收益对于所选择的方案，说明能够带来的收益，这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等，包括：6.2.1 一次性收益说明能够用人民币数目表示的一次性收益，可按数据处理、用户、管理和支持等项分类叙述。6.2.2 非一次性收益说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，

7、包括开支的减少和避免。6.2.3 不可定量的收益逐项列出无法直用人民币表示的收益。6.3 收益/投资比求出整个系统生命期的收益 /投资比值。6.4 投资回收周期求出收益的累计数开始超过支出的累计数的时间。6.5 敏感性分析是指一些关键性因素与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时，对开支和收益的影响最灵敏的范围的估计。7社会因素方面的可能性7.1.法律方面的可行性7.2.使用方面的可行性8结论a. 在进行可行性研究报告的编制时，必须有一个研究的结论二、需求分析文档需求规格说明书(ISO 标准版)编者说明：当需求调查、分析工作告一段落时，你就需要将这些需求进行规格化描

8、述，整理成文，即软件需求规格说明书，也就是 SRS。这是在软件项目过程中最有价值的一个文档。 ISO所提供的标准虽然已经时间久远，但还是颇具参考价值的。1引言1.1 编写的目的说明编写这份需求说明书的目的 ,指出预期的读者。1.2 背景a. 待开发的系统的名称;b. 本项目的任务提出者、开发者、用户；c. 该系统同其他系统或其他机构的基本的相互来往关系。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出用得着的参考资料。 2任务概述2.1 目标叙述该系统开发的意图、应用目标、作用范围以及其他应向读者说明的有关该系统开发的背景材料。解释被开发系统与其他有关

9、系统之间的关系。2.2 用户的特点列出本系统的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本系统的预期使用频度。2.3 假定和约束列出进行本系统开发工作的假定和约束。 3需求规定 3.1 对功能的规定用列表的方式，逐项定量和定性地叙述对系统所提出的功能要求，说明输入什么量、经怎么样的处理、得到什么输出，说明系统的容量,包括系统应支持的终端数和应支持的并行操作的用户数等指标。3.2 对性能的规定3.2.1 精度说明对该系统的输入、输出数据精度的要求，可能包括传输过程中的精度。3.2.2 时间特性要求说明对于该系统的时间特性要求。3.2.3 灵活性说明对该系统的灵活性的要求

10、，即当需求发生某些变化时，该系统对这些变化的适应能力。3.3 输入输出要求解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对系统的数据输出及必须标明的控制输出量进行解释并举例。3.4 数据管理能力要求（针对软件系统）说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。3.5 故障处理要求列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。3.6 其他专门要求如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。4运行环境规定4.1 设备列出运行该

11、软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：a. 处理器型号及内存容量b. 外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量c. 输入及输出设备的型号和数量，联机或脱机；d. 数据通信设备的型号和数量e. 功能键及其他专用硬件4.2 支持软件列出支持软件，包括要用到的操作系统、编译程序、测试支持软件等。4.3 接口说明该系统同其他系统之间的接口、数据通信协议等。4.4 控制说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。三、项目计划书编者说明：随着现代软件工程思想的普及，迭代的、增量的开发生命周期已经被认识并付诸实践，针对这样的生命周期，其项目计划的格式也

12、需要做出相应的调整。1. 文档概述在此对整个文档进行概要性描述，另外还应列出该计划的目标、范围、定义、术语、参考资料等内容。1.1 目标在此描述本项目计划的目标。1.2 范围简要说明该计划所覆盖的范围，以及与其相关的项目，与该文档有联系的事物。1.3 定义与术语在此列出在该计划中所涉及的所有术语、定义、缩写词的解释，这些信息也可以引用项目词汇表来提供。1.4 参考资料在此应列出项目计划中引用的文档列表，对于引用的每个文档都应该列出其标题、文档编号、日期，并且指出这些文档的来源，以方便该计划的阅读者查找。1.5 概述说明该计划其它部分所包含的内容，以及文档的组织方式。2. 项目概述项目目标指出该

13、项目将会交付什么样的产品，能够帮助客户达到什么目标。假设与约束列举出制定该计划时所做的所有假设，以及列举出对该项目的解决方案的约束性要求，如特定的操作系统平台、特定的时间、特定的经费范围等。项目交付物具体列出该项目完成后，将交付哪些东西，并可以列出每个交付时间。项目计划更新总结建议采用表格的形式，将计划的修订过程列出来。3. 项目组织项目组织结构建议使用组织结构图的形式，将整个项目团队成员之间的关系与职责明确下来，甚至可以包括管理人员、各种委员会等。外部联系人列出开发组织之外的，所有与项目相关的外部人员的姓名、联系电话等资料。角色与职责明确项目开发各个任务的负责人或小组。4. 项目管理计划项目

14、估计给出关于项目成本、进度的估计值，这些估计值将是项目计划制定的基础，也是今后重新评估、修改计划的基础。你可以采用任何估算技术。项目计划4.2.1 阶段计划主要包括工作结构分解（WBS） 、显示各个阶段或迭代时间安排的甘特图、主要里程碑与其验收标准。4.2.2 迭代目标如果你采用的是迭代式的开发方法，那么在此列出每次迭代的计划，以及每次迭代计划实现的目标。4.2.3 发行计划列出软件开发过程中各个中间版本的发行时间，包括演示版、Alpha 版、Beta 版等。 4.2.4 项目进度表使用甘特图或 PERT 图等方法，表示出该项目的进度计划。4.2.5 项目资源计划在此处应列出项目所需的人员、设

15、备等资源情况。应指明所需人员的数量、技能要求，以及如何获取这些资源，是否要对人员进行必要的培训等。4.2.6 项目预算根据 WBS 和阶段计划分配成本，得到本项目的财务预算。迭代计划根据 4.2.2 小节的目标，具体列出每次迭代的详细计划。该部分可以视需要将其单列为专题计划。4.3.1 迭代一4.3.1.1 计划列出此次迭代的时间线、小型里程碑等。4.2.1.2 资源列出此次迭代所需的人力、财力、设备等资源。4.2.1.3 用例列出此次迭代将要实现的用例。4.2.1.4 评估标准列出此次迭代的各项评测标准，包括功能、性能、容量、质量等。项目监督与控制4.4.1 需求管理计划有针对性对制定各类需

16、求元素的管理与跟踪办法。该部分可以视需要将其单列成为专题计划。4.4.2 进度控制计划说明如何对项目计划执行情况进行监控，将采用什么措施与管理手段。4.4.3 预算控制计划说明如何对项目的财务预算进行控制，以保证成本最小化。4.4.4 质量控制计划说明如何保证项目的质量，以及一些应急的应对措施。该部分可以视需要将其单列成为专题计划。4.4.5 报告计划说明项目开发过程中，整个项目团队的报告机制，什么时候、谁、报送什么数据，从而形成规则。4.4.6 评测计划制定项目开发过程中将要度量与评测的指标，说明如何评测，如何应对。该部分可以视需要将其单列成为专题计划。4.5 风险管理计划该部分可以视需要将

17、其单列为专题计划。4.5.1 风险总述对项目所涉及的风险进行一个概要性描述。4.5.2 风险管理任务简要地说明在该项目中，风险管理所涉及的内容，可以包括用来确定风险的方法、对风险列表进行分析和确定优先级的方式、将采用的风险管理策略、对最严重的风险所计划的降低/ 规避或预防的策略、监测风险状态的方式、风险复审的时间表。4.5.3 风险管理的组织和职责列出与风险管理相关的个人或小组，并对其职责进行描述。4.5.4 工具与技术列出与风险管理将采用的工具软件或技术。4.5.5 纳入管理的风险项列出主要的风险项，并描述其影响以及应急措施。具体可以参考后面的风险条目跟踪表模板 。4.6 收尾计划列出在项目

18、后期将要做的事，包括材料存档、汇报总结等。5. 相关技术5.1 开发案例给出本项目将采用的软件生命周期模型、过程规范等，从而对开发过程给予明确的指导。该部分可以视需要将其单列为一个专题文件。5.2 方法、工具和技术列出本项目中将运用的方法、工具和技术，并给出适当的工作指南和说明。5.3 产品验收计划列出本项目验收工作的一些细节计划，本部分内容可以视需要将其单列为一个专题计划。6其它支持过程管理6.1 配置管理计划在此列出该项目所采用的配置管理过程，通常是单列为一个专题。6.2 评估计划列出本项目评估时所使用的技术、标准、指标和过程。这里的评估包括走查、检查和复审。6.3 文档计划6.4 质量保

19、证计划6.5 分包商管理计划7.其他计划8.附录9.索引四、数据要求说明书编者说明：如果在你的项目中有大量要求数据存储、数据采集等方面的需求，那么你就应该专门将这些需求进行整理，以数据要求说明书的形式表现出来。1引言1.1 编写目的说明编写这份数据要求说明书的目的，指出预期的读者。1.2 背景a.待开发软件系统的名称；b.列出本项目的任务提出者、开发者、用户以及将运行该项软件的计算站或计算机网络系统。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出有关的参考资料。 2数据的逻辑描述对数据进行逻辑描述时可把数据分为动态数据和静态数据。2.1 静态数据列出

20、所有作为控制或参考用的静态数据元素。 2.2 动态输入数据列出动态输入数据元素。 2.3 动态输出数据列出动态输出数据元素。 2.4 内部生成数据列出向用户或开发单位中的维护调试人员提供的内部生成数据。2.5 数据约定说明对数据要求的制约。逐条列出对进一步扩充或使用方面的考虑而提出的对数据要求的限制。对于在设计和开发中确定是临界性的限制更要明确指出。3数据的采集 3.1 要求和范围按数据元的逻辑分组来说明数据采集的要求和范围，指明数据的采集方法，说明数据采集工作的承担者是用户还是开发者。3.2 输入的承担者说明预定的对数据输入工作的承担者。如果输入数据同某一接口软件有关，还应说明该接口软件的来

21、源。3.3 预期处理对数据的采集和预处理过程提出专门的规定，包括适合应用的数据格式、预定的数据通信媒体和对输入的时间要求等。对于需经模拟转换或数字转换处理的数据量，要给出转换方法和转换因子等有关信息，以便软件系统使用这些数据。3.4 影响说明这些数据要求对于设备、软件、用户、开发单位所可能产生的影响。五、概要设计文档编者说明：这是 ISO 提供的规范，是最原始的概要设计说明书的编写格式，其适用于结构化设计思想下的软件设计，不过其中还是有很多具有参考价值的内容。1引言1.1 编写目的说明编写这份概要设计说明书的目的，指出预期的读者。1.2 背景a.待开发软件系统的名称；b.列出本项目的任务提出者

22、、开发者、用户。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料列出有关的参考资料。 2总体设计2.1 需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求。包括2.1.1 系统功能2.1.2 系统性能2.1.2.1 精度2.1.2.2 时间特性要求2.1.2.3 可靠性2.1.2.4 灵活性2.1.3 输入输出要求 2.1.4 数据管理能力要求2.1.5 故障处理要求2.1.6 其他专门要求2.2 运行环境简要地说明对本系统的运行环境的规定。 2.2.1 设备列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。2.2.2 支持软件列出

23、支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。2.2.3 接口说明该系统同其他系统之间的接口、数据通信协议等2.2.4 控制说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。2.3 基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。2.4 结构给出系统结构总体框图（包括软件、硬件结构框图） ，说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，分层次地给出各模块之间的控制与被控制关系。2.5 功能需求与系统模块的关系本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。系统模块 1 系统模块 2 系统模块 m功能需求

24、 1 功能需求 2 功能需求 n 2.6 人工处理过程说明在本系统的工作过程中不得不包含的人工处理过程。2.7 尚未解决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3接口设计3.1 用户接口说明将向用户提供的命令和它们的语法结构，以及相应的回答信息。说明提供给用户操作的硬件控制面板的定义。3.2 外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。3.3 内部接口说明本系统之内的各个系统元素之间的接口的安排。4运行设计4.1 运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种

25、运行所历经的内部模块的支持软件。4.2 运行控制说明每一种外界的运行控制的方式方法和操作步骤。4.3 运行时间说明每种运行模块组合将占用各种资源的时间。5系统数据结构设计不涉及软件设计可不包含5.1 逻辑结构设计要点给出本系统内软件所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。5.2 物理结构设计要点给出本系统内软件所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系、设计考虑和保密条件。5.3 数据结构与程序的关系说明各个数据结构与访问这些数据结构的各个程序之间的对应关系。程序 1 程

26、序 2 程序 m数据结构 1 数据结构 2 数据结构 n 6系统出错处理设计6.1 出错信息用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。6.2 补救措施说明故障出现后可能采取的变通措施。包括： a. 后备技术 说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术。b. 降效技术 说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录。c. 恢复及再启动技术 说明将使用的恢复再启动技

27、术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3 系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。六、详细设计文档编者说明：概要设计通常是项目中专门的人员完成，是对系统的高层描述，而详细设计的任务则通常由每一个任务实施人来完成，其是对某个具体的模块、类等局部元素的设计描述。该模板是 ISO 推荐的格式，其仍然是以结构化设计为主要思想。1.引言1.1 编写目的说明编写这份详细设计说明书的目的，指出预期的读者。1.2 背景a. 待开发系统的名称；b. 列出本项目的任务提出者、开发者、用户。1.3 定义列出本

28、文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出有关的参考资料。 2. 系统的结构给出系统的结构框图，包括软件结构、硬件结构框图。用一系列图表列出系统内的每个模块的名称、标识符和它们之间的层次结构关系。3模块 1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。3.1 模块描述给出对该基本模块的简要描述，主要说明安排设计本模块的目的意义，并且，还要说明本模块的特点

29、。3.2 功能说明该基本模块应具有的功能。 3.3 性能说明对该模块的全部性能要求。 3.4 输入项给出对每一个输入项的特性。 3.5 输出项给出对每一个输出项的特性。 3.6 设计方法（算法）对于软件设计，应详细说明本程序所选取用的算法，具体的计算公式及计算步骤。对于硬件设计，应详细说明本模块的设计原理、元器件的选取、各元器件的逻辑关系，所需要的各种协议等。3.7 流程逻辑用图表辅以必要的说明来表示本模块的逻辑流程。3.8 接口说明本模块与其它相关模块间的逻辑连接方式，说明涉及到的参数传递方式。3.9 存储分配根据需要，说明本模块的存储分配。 3.10 注释设计说明安排的程序注释。 3.11

30、 限制条件说明本模块在运行使用中所受到的限制条件。 3.12 测试计划说明对本模块进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件、驱动程序及桩模块等的规定。3.13 尚未解决的问题说明在本模块的设计中尚未解决而设计者认为在系统完成之前应解决的问题。4模块 2（标识符）设计说明用类似第 3 条的方式，说明第 2 个模块乃至第 N 个模块的设计考虑。 七、模块开发说明编程说明：该文档将与模块开发卷宗结合使用，卷宗是对整个系统进行整理，而模块开发说明则是对具体的模块进行说明，其作用于归档阶段。1标题系统名称和标识符模块名称和标识符程序编制员签名卷宗的修改文

31、本序号修改完成日期卷宗序号编排日期2模块开发情况表3功能说明扼要说明本模块的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在需求说明书中对这些功能的说明的章、条、款。4设计说明说明本模块的设计考虑5硬件部分的设计结果1） 经项目组调试通过的硬件成品 1 件2）设计文件：原理图PCB 图BOM 清单可编程器件及烧录进制文件必要测试点波形图或硬件指标评细说明原理详细说明与系统内其他部分接口软硬件详细说明这些文件可以附件的形式列后。6软件的设计结果要给出所产生的本模块的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源程序代码。7测试说明说明直接要经过本模块的每一项

32、测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。8复审的结论把实际测试的结果，同需求说明书、系统设计说明书中规定的要求进行比较和给出结论。八、软件测试报告软 件 测 试 报 告项目编号： 项目名称： 任务编号/序号： 工作名称： 程序（ID）： 程序名称： 编程员： 测试完成日期： 年 月 日测试工程师： 测试完成日期： 年 月 日1、安装：（1）程序运行环境已经正确设定 2、程序代码检查：是 否（1）程序单位首部有程序说明和修改备注 （2）变量、过程、函数命令符合规则 （3）程序中有足够的说明信息 （4）修改注释符合要求 （5）类库的使用符

33、合要求 3、画面及报表格式检查：（1）画面和报表格式符合规定需求 （2）程序命名符合格式需求 （3）画面和报表的字段位置和宽度与设计文档一致 4、功能测试：（1）多画面之间切换正确 （2）功能键、触发键、按钮、菜单、选择项功能正确 （3）数据项关联及限制功能正确 （4）设计文档规定的其它功能测试内容： 5、正确性测试：（1）读/写/删除操作结果正确（2）各种组合条件之查询或报表正确 （3）设计文档规定的其它操作测试内容： 6、可靠性测试：（1）非法键容错测试 （2）异常字符容错测试 （3）程序负作用检查（4）残留文件检查7、效率测试：单用户（机型） 多用户（终端数） （1） 输入画面效率测试：

34、延迟时间： （2） 报表及查询效率测试：最小报表时间： 最大报表时间： 8、多用户测试：终端数： （1）随机测试：测试次数： （2）共享测试： （3）同步测试： 9、其它测试：测试内容： 测试备忘：九、软件维护报告编者说明：该表格用于开发部门对软件所做出的维护性修改，将其记录在案，是十分必要的，防止文档的不一致性带来的维护麻烦。维护案例的标志：_维护活动的标志：_维护需求的类型： 改正 改编 调整 扩充需要维护的原因和维护后产生的影响：原 因 影 响需求定义设计软件环境硬件环境优化其它所有维护过的模块和系统的结果及成本/工作：对所做维护工作的注释：维护人签名：日期：模块标志维护的行数不清 工作

35、(人小时 )源码 文档 总计总计十、软件使用手册编者说明：为用户提供一个使用手册，是提升软件可用性的必要措施。用户手册的作用是让用户对整个软件系统有一个宏观的认识。解决安装问题，告知运行环境，介绍主要功能等。1 引言1.1 编写目的说明编写这份用户手册的目的，指出预期的读者。1.2 背景说明：a. 这份用户手册所描述的软件系统的名称；b. 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的计算中心。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出有用的参考资料，如：a. 项目的经核准的计划任务书或合同、上级机关的批文；b. 属于本项目的其

36、他已发表文件；c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料的来源。2 用途2.1 功能结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。2.2 性能2.2.1 精度逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度要求。2.2.2 时间特性定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。2.2.3 灵活性说明本软件所具有的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时间特性等的要求）有某些变化时，本软件

37、的适应能力。2.3 安全保密说明本软件在安全、保密方面的设计考虑和实际达到的能力。3 运行环境3.1 硬设备列出为运行本软件所要求的硬设备的最小配置，如：a. 处理机的型号、内存容量;b. 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机脱机；c. IO 设备（联机脱机？） ；d. 数据传输设备和转换设备的型号、台数。3.2 支持软件说明为运行本软件所需要的支持软件，如：a. 操作系统的名称、版本号；b. 程序语言的编译汇编系统的名称和版本号；c. 数据库管理系统的名称和版本号；d. 其他支持软件。3.3 数据结构列出为支持本软件的运行所需要的数据库或数据文件。4 使用过程在本章，首先

38、用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。4.1 安装与初始化一步一步地说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。4.2 输入规定输入数据和参量的准备要求。4.2.1 输入数据的现实背景说明输入数据的现实背景，主要是：a. 情况-例如人员变动、库存缺货；b. 情况出现的频度-例如是周期性的、随机的、一项操作状态的函数 .c. 情况来源- 一例如人事部门、仓库管理部门；d. 输入媒体-例如键盘、穿孔卡片、磁

39、带；e. 限制-出于安全、保密考虑而对访问这些输入数据所加的限制；f. 质量管理 -例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，如建立出错情况的记录等；g. 支配 -例如如何确定输入数据是保留还是废弃，是否要分配给其他的接受者等。4.2.2 输入格式说明对初始输入数据和参量的格式要求，包括语法规则和有关约定，如：a. 长度- 一例如字符数行，字符数项；b. 格式基准-例如以左面的边沿为基准；c. 标号-例如标记或标识符；d. 顺序-例如各个数据项的次序及位置；e. 标点 -例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等。f. 词汇表 -给出允许使用的字

40、符组合的列表，禁止使用的字符组合的列表等；g. 省略和重复-给出用来表示输人元素可省略或重复的表示方式；h. 控制-给出用来表示输入开始或结束的控制信息。4.2.3 输入举例为每个完整的输入形式提供样本，包括： a. 控制或首部- 例如用来表示输入的种类和类型的信息，标识符输入日期，正文起点和对所用编码的规定；b. 主体-输入数据的主体，包括数据文件的输入表述部分；c. 尾部-用来表示输入结束的控制信息，累计字符总数等；d. 省略-指出哪些输入数据是可省略的；e. 重复-指出哪些输入数据是重复的。4.3 输出对每项输出作出说明.4.3.1 输出数据的现实背景，说明输出数据的现实背景，主要是：a

41、. 使用-这些输出数据是给谁的，用来干什么；b. 使用频度-例如每周的、定期的或备查阅的；c. 媒体-打印、CRI 显示、磁带、卡片、磁盘，d. 质量管理-一例如关于合理性检验、出错纠正的规定；e. 支配-例如如何确定输出数据是保留还是废弃，是否分配给其他接受者等。4.3.2 输出格式给出对每一类输出信息的解释，主要是： a. 首部-如输出数据的标识符，输出日期和输出编号；b. 主体-输出信息的主体，包括分栏标题；c. 尾部-包括累计总数，结束标记。4.3.3 输出举例为每种输出类型提供例子。对例子中的每一项，说明：a. 定义-每项输出信息的意义和用途；b. 来源 -是从特定的输入中抽出、从数

42、据库文件中取出、或从软件的计算过程中得到；c. 特性-输出的值域、计量单位、在什么情况下可缺省等。4.4 文件查询这一条的编写针对具有查询能力的软件，内容包括：同数据库查询有关的初始化、准备、及处理所需 要的详细规定，说明查询的能力、方式，所使用的命令和所要求的控制规定。4.5 出错处理和恢复列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢 复的能力，用户必须遵循的处理过程。4.6 终端操作当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排、连接步骤、数据和参数输入步骤以及控制规定说明。通过终端操作进行查询、检索、修改数据文件的能力、语言、过程以及辅助性程序等。