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

《软件开发文档模板-软件产品开发文件编制指南33244138906.docx》由会员分享，可在线阅读，更多相关《软件开发文档模板-软件产品开发文件编制指南33244138906.docx（13页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

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

2、与内容要要求。l、可行性性研究报告告可行性研究究报告的目目的是：说说明该软件件开发项目目的实现在在技术上、经经济上和社社会条上的的可行性，论论述为了合合理地达到到开发目标标而可能选选择的各种种方案，说说明并论证证所选定的的方案。可可行性研究究报告的编编写内容见见表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局限限性

3、4.所建议议的系统4.1对所所建议系统统的说明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.77对经费开开支的影响响4.5局限限性4.6技术术条件方面面的可行性性5.可选择择的其他系系统方案5.1可选选择的系统统方案1 5.22可选择的的系统方案案26.投资及及收益分析析6.1支出出 6.1.1基基本建设投投资 6.1.2其其他一次性性支出 6.1.3非非一次性支支出6.2收益益 6.2.

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

5、工工作内容 2.2主主要参加人人员 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.22物理结构构设计要点点 5.33数据结构构设计要点点6.

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

10、算法 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.结构设设计3.1概念念结构设计计3.2逻辑辑3.3物理理结构设计计4.运用设设计 4.1数数据字典设设计 4.2安

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

12、.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.3定义义1.4参考考资料2.软件概概述2.1软件件的结构2.2程序序表2.3文卷卷表3.安装与与初始化4.运行说说明4.1运行行表4.2运行行步骤 4.33

13、运行1(标识符)说明 4.3.1运运行控制 4.3.2操操作信息 4.3.3输输出文段 4.3.4输输出文段 4.3.5输输出文段的的复制 4.3.6启启动恢复过过程 4.4运运行2(标标识符)说说明5.非常规规过程6.远程过过程10、模块块开发卷宗宗 模模块开发卷卷宗是在模模块开发过过程中逐步步编写出来来的。每完完成一个模模块或一组组密切相关关的模块，复复审时编写写出一份，应应该把所有有的模块开开发卷宗汇汇集在一起起。编写的的目的是记记录和汇总总低层次开开发的进度度和结果；以便于对整个系系统开发工工作进行管管理的复审审，并为将将来的维护护提供有用用的技术信信息。具体体内容要求求见表100。1

14、1、测试试计划表10 模块开发发卷宗1.标题2.模块开开发情况表表(见附表表S10.10a)3.功能说说明4.设计说说明5.源代码码清单6.测试说说明7.复审的的结论表10a 模块开开发情况表表模块标识符符模块的描述述性名称代码设计计划开始日日期实际开始日日期计划完成日日期实际完成日日期模块测试计划开始日日期实际开始日日期计划完成日日期实际完成日日期组装测试计划开始日日期实际开始日日期计划完成日日期实际完成日日期代码复查日日期/签字字源代码行数数目标模块大大小项目负责人人批准日期期/签字 这这里所说的的测试是指指整个软件件系统的组组装测试和和确认测试试，本文件件的编制是为为了提供一一个对该软软

15、件的测试试计划，包包括对每项项测试活动动的内容、进进度安排、设设计考虑、测测试数据的的整体性方方法及评价价准则。具具体内容见见表11。表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测试试2(标识识符) 3.测试设设计说明 3.11测试1(标识符) 3.1.1控控制 3.1.2输输入 3.1.3输输出 3.1.4过过程 3.22测试2(标识符) 4.评价准准则 4.1范范围 4.2数数据整理 4.3尺尺度12

16、、测试试分析报告告测试分析报报告的编写写是为了把把组装测试试和确认测测试的结果果、发现的的问题以及及分析结果果写出成文文件形式加加以保存，具具体编写内内容要求见见表12。表12 测试分析析报告1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.测试概概要3.测试结结果及发现现 3.11测试1(标识符) 3.22测试2(标识符) 4.对软件件功能的结结论 4.1功能能1(标识识符) 4.1.1能力 4.1.2限制4.2功能能2(标识识符) 5.分析摘摘要 5.11能力 5.22缺陷和限限制 5.33建议 5.44评价6.测试资资源消耗13、开发发进度月报报开发进度月月报的编制制目

17、的是及及时向有关关管理部汇汇报项目开开发的进度度和情况,以便及时时发现和处处理开发过过程中出现现的问题。一一般来说，开开发进度月月报是以项项目组为单单位每月编编写的，具具体内容要要求见表113。表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、项目目开发总结结报告项目开发总总结报告的的编制是为为了总结本本项目开发发工作的经验验，说明实实际取得的的开发成果果以及对整整个开发工工作的各个个方面的评评价，具体体内容要求求见表144。表14 项目开发发总结报告告1.引言1.1编写写目的1.2背景景1.3定义义1.4参考考资料2.实际开开发结果 2.11产品 2.22主要功能能和性能 2.33基本流程程 2.44进度 2.55费用3.开发工工作评价 3.11对生产效效率的评价价 3.22对产品质质量的评价价 3.33对技术方方法的评价价 3.44出错原因因的分析4.经验与与教训13