软件开发文档模板-软件产品开发文件编制指南

1、医院信息系统的建设与应用医院信息系统的建设与应用PAGE 286PAGE 18附录五 国家标准计算机软件产品开发文件编制指南 国家标准计算机软件产品开发文件编制指南（GB 856788）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。l、可行性研究报告可行性研究究报告的的

2、目的是是：说明明该软件件开发项项目的实实现在技技术上、经经济上和和社会条条上的可可行性，论论述为了了合理地地达到开开发目标标而可能能选择的的各种方方案，说说明并论论证所选选定的方方案。可可行性研研究报告告的编写写内容见见表l。表l 可可行性研研究报告告1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.可行性性研究的的前提2.1要求求2.2目标标2.3条件件、假定定和限制制2.4进行行可行性性研究的的方法2.5评价价尺度3.对现有有系统的的分析3.1数据据流程和和处理流流程3.2工作作负荷3.3消费费开支3.4人员员3.5设备备3.6局限限性4.所建议议的系统统4.1对所所建议

3、系系统的说说明4.2数据据流程和和处理流流程4.3改进进之处4.4影响响4.4.11对设备备的影响响4.4.22对软件件的影响响4.4.33对用户单位位机构的影响响4.4.44对系统统运行的的影响 44.4.5对开开发的影影响 44.4.6对地地点和设设施的影影响 44.4.7对经经费开支支的影响响4.5局限限性4.6技术术条件方方面的可可行性5.可选择择的其他他系统方方案5.1可选选择的系系统方案案1 5.22可选择择的系统统方案226.投资及及收益分分析6.1支出出 6.1.11基本建建设投资资 6.1.22其他一一次性支支出 6.1.33非一次次性支出出6.2收益益 6.2.11一次性性

4、收益 6.2.22非一次次性收益益 6.2.33不可定定量的收益益6.3收益益/投资资比6.4投资资回收周期期6.5敏感感性分析析7.社会条条件方面面的可行行性7.1法律律方面的的可行性性7.2使用用方面的的可行性性8.结论2、项目开开发计划划 编编制项目目开发计计划的目目的是用用文件的的形式，并在开发过程中各项工作的负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。表2 项项目开发发计划1.引言 1.1编编写目的的 1.2背背景 1.3定定义 1.4参参考资料料2.项目概概述 2.1工工作内容容 2.2主主要

5、参加加人员 2.3产产品及成成果 2.33.1程程序 2.33.2文文件 2.33.3服服务 2.33.4非非移交产产品 2.4验验收标准准2.5完成成项目的的最迟期期限2.6本计计划的审审批者与与批准者者3.实施总总计划 3.1工工作任务务的分析析 3.2接接口人员员 3.3进进度 3.4预预算 3.5关关键问题题4.支持条条件 4.1计计算机统统支持 4.2需需要用户户承担的的工作 4.3需需由外单单位提供供的条件件5.专题计计划要点点3、软件需需求说明明书软件需求说说明书的的编制是是为了使使用户和和软件开开发人员员双方对对该软件件的初始始规定有有一个共共同的理理解，使使之成为为整个软软件

6、开发发工作的的基础。其其内容要要求见表表3。表3 软软件需求求说明书书1.引言 1.1编编写目的的 1.2背背景 1.3定定义 1.4参参考资料料2.任务概概述 2.1目目标 2.2用用户的特特点 2.3假假定的约约束3.需求规规定 3.1对对功能的的规定 3.2对对性能的的规定 3.22.1精精度 3.22.2时时间特性性要求 3.22.3灵灵活性 3.3输输入输出出要求 3.4数数据管理理要求 3.5故故障处理理要求 3.6其其他专门门要求4.运行环环境规定定 4.1设设备 4.2支支撑软件件 4.3接接口 4.4控控制4、数据要要求说明明书数据要求说说明书的编制制目的是是为了向向整个软软

7、件开发发时期提提供关于于被处理理数据的的描述和和数据采采集要求求的技术术信息，其其内容要要求列于于表4中中。表4 数数据要求求说明书书1.引言 1.1编编写目的的 1.2背背景 1.3定定义 1.4参参考资料料2.数据的的逻辑描描述 2.1静静态数据据 2.2动动态输入入数据 2.33动态输输出数据据 2.44内部生生成数据据 2.55数据约约定3.数据的的采集 3.1要要求的范范围 3.2输输入的承承担者 3.3 处理 3.4 影响5、概要设设计说明明书 概概要设计计说明书书又称为为总体设设计说明明书，编编制目的的是说明明对项目目系统的的设计考考虑，包包括基本本处理流流程、组组织结构构、模块

8、块结构、功功能配置置、接口口设计、运运行设计计、系统统配置、数数据结构构设计和和出错处处理设计计等，为为程序的的详细设设计提供供基础。其其内容要要求见表表5。表5 概概要设计计说明书书1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2. 总体体设计2.1运行行环境2.2基本本设计概概念和处处理流程程2.3结构构2.4功能能需求与与程序的的关系2.5人工工处理过过程2.6尚未未解决的的问题3. 接口口设计3.1用户户接口3.2外部部接口3.3内部部接口4. 运行行设计4.1 运运行模块块组合4.2运行行控制4.3运行行时间5. 系统统数据结结构设计计5.1逻辑辑结构设计计要点 5

9、.22物理结结构设计计要点 5.33数据结结构设计计要点6. 系统统出错处处理设计计6.1出错错信息 6.22补救措措施 6.33系统维维护设计计6、详细设设计说明明书 详详细设计计说明书书又称为为程序设设计说明明，编制目目的是说说明一个个软件系系统各个个层次中中的每一一个程序序（模块块）的设计计考虑。如如果软件件系统比比较简单单，层次次少，本本文件可可以不单单独编写写，有关关内容可可并入概概要设计计说明书书。详细细设计说说明书的的内容要要求见表表6。表6 详详细设计计说明书书1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.程序系系统的组组织结构构3.程序11（结构构符）设

10、设计说明明3.1程序序描述3.2功能能3.3性能能3.4输入入项 3.5输输出项 3.6算算法 3.7流流程逻辑辑 3.8接接口 3.9存存储分配配 3.100注释设设计 3.111限制条条件 3.122测试设设计 3.133尚未解解决的问问题4.程序22（标识识符）设设计说明明书7、数据库库设计说说明书数据库设计计说明书书的编制制目的是是对于设设计中的的数据的的所有标标识、逻逻辑结表7 数数据库设设计说明明书1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.外部设设计2.1标识识符和状状态2.2使用用它的程程序2.3约定定 2.44专门指指导 2.44支撑软软件3.结构设设

11、计3.1概念念结构设设计3.2逻辑辑3.3物理理结构设设计4.运用设设计 4.1数数据字典典设计 4.2安安全保密密设计构和物理结结构做出出具体的的设计规规定。内内容要求求见表77。8、用户手手册用户手册的的编制是是使用非非专业术术语的语语言，充充分地描描述该软软件系统统所具有有的功能能及基本本的使用用方法。使使用户通通过本手手册能够够了解该该软件的的用途，并并能够确确定在什什么情况况下、如如何使用用它。具具体的内内容要求求见表88。表8 用用户手册册1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.用途2.1功能能2.2性能能 2.2.1精度度 2.2.2时间间特性 2.2

12、.3灵活活性3.运行环环境3.1硬环环境3.2支撑撑软件3.3数据据结构4.使用过过程 4.1安安全与初初始化 4.2输输入 4.22.1输输入数据据的现实实背景 4.22.2输输入格式式 4.22.3输输入举例例 4.3输输出 4.33.1输输出数据据的现实实背景 4.33.2输输出格式式 4.33.3输输出举例例 4.4文文卷查询询 4.5出出错处理理与恢复复 4.6终终端操作作9、操作手手册 操操作手册册的编制制是为了了向操作作人员提提供该软软件每个运运行的具具体过程程的有关关知识，包包括操作作方法的的细节。内内容要求求见表99。表9 操操作手册册1.引言1.1编写写目的1.2背景景1.

13、3定义义1.4参考考资料2.软件概概述2.1软件件的结构构2.2程序序表2.3文卷卷表3.安装与与初始化化4.运行说说明4.1运行行表4.2运行行步骤 4.33运行11(标识识符)说说明 4.3.11运行控控制 4.3.22操作信信息 4.3.33输出文文段 4.3.44输出文文段 4.3.55输出文文段的复复制 4.3.66启动恢恢复过程程 4.4运运行2(标识符符)说明明5.非常规规过程6.远程过过程10、模块块开发卷卷宗 模模块开发发卷宗是是在模块块开发过过程中逐逐步编写写出来的的。每完完成一个个模块或或一组密密切相关关的模块块，复审审时编写写出一份份，应该该把所有有的模块块开发卷卷宗汇

14、集集在一起起。编写写的目的的是记录录和汇总总低层次次开发的的进度和和结果；以便于对整个个系统开开发工作进行行管理的的复审，并并为将来来的维护护提供有有用的技技术信息息。具体体内容要要求见表表10。11、测试试计划表10 模块开开发卷宗宗1.标题2.模块开开发情况况表(见见附表SS10.10aa)3.功能说说明4.设计说说明5.源代码码清单6.测试说说明7.复审的的结论表10a 模块块开发情情况表模块标识符符模块的描述述性名称称代码设计计划开始日日期实际开始日日期计划完成日日期实际完成日日期模块测试计划开始日日期实际开始日日期计划完成日日期实际完成日日期组装测试计划开始日日期实际开始日日期计划完

15、成日日期实际完成日日期代码复查日日期/签签字源代码行数数目标模块大大小项目负责人人批准日日期/签签字 这这里所说说的测试试是指整整个软件件系统的的组装测测试和确确认测试试，本文文件的编制是是为了提提供一个个对该软软件的测测试计划划，包括括对每项项测试活活动的内内容、进进度安排排、设计计考虑、测测试数据据的整体体性方法法及评价价准则。具具体内容容见表111。表11 测试计计划1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.计划2.1软件件说明2.2测试试内容2.3测试试1(标标识符) 2.3.1进度度安排 2.3.2条件件 2.3.3测试试资料 2.3.4测试试培训2.4测试

16、试2(标标识符) 3.测试设设计说明明 3.11测试11(标识识符) 3.1.11控制 3.1.22输入 3.1.33输出 3.1.44过程 3.22测试22(标识识符) 4.评价准准则 4.1范范围 4.2数数据整理理 4.3尺尺度12、测试试分析报报告测试分析报报告的编编写是为为了把组组装测试试和确认认测试的的结果、发发现的问问题以及及分析结结果写出出成文件件形式加加以保存存，具体体编写内内容要求求见表112。表12 测试分分析报告告1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.测试概概要3.测试结结果及发发现 3.11测试11(标识识符) 3.22测试22(标识识符

17、) 4.对软件件功能的的结论 4.1功能能1(标标识符) 4.1.1能力力 4.1.2限制制4.2功能能2(标标识符) 5.分析摘摘要 5.11能力 5.22缺陷和和限制 5.33建议 5.44评价6.测试资资源消耗耗13、开发发进度月月报开发进度月月报的编编制目的的是及时时向有关关管理部部汇报项项目开发发的进度度和情况况,以便便及时发发现和处处理开发发过程中中出现的的问题。一一般来说说，开发发进度月月报是以以项目组组为单位位每月编编写的，具具体内容容要求见见表133。表13 开发进进度月报报1.标题2.工程进进度与状状态 2.1进进度 2.2态态度3.资源耗耗用与状状态 3.1资资源耗用用 3.11.1工工时 3.11.2机机时 3.2状状态4.经费支支出与状状态 4.1经经费支出出 4.11.1支支出性费费用 4.11.2设设备购置置费 4.2状状态5.下个月月的工作作计划6.建议14、项目目