首页 软件开发文档指南

软件开发文档指南

举报
开通vip

软件开发文档指南软件开发文档指南 1 可行性研究报告 1引言 ........................................................................................................................................... 2 1.1编写目的........................................................................................

软件开发文档指南
软件开发文档指南 1 可行性研究报告 1引言 ........................................................................................................................................... 2 1.1编写目的................................................................................................................................. 2 1.2背景......................................................................................................................................... 2 1.3定义......................................................................................................................................... 2 1.4参考资料................................................................................................................................. 2 2可行性研究的前提........................................................................................................................ 2 2.1要求......................................................................................................................................... 2 2.2目标......................................................................................................................................... 3 2.3条件、假定和限制 ................................................................................................................. 3 2.4进行可行性研究的方法 ......................................................................................................... 3 2.5评价尺度................................................................................................................................. 3 3对现有系统的分析........................................................................................................................ 4 3.1处理流程和数据流程 ............................................................................................................. 4 3.2工作负荷................................................................................................................................. 4 3.3费用开支................................................................................................................................. 4 3.4人员......................................................................................................................................... 4 3.5设备......................................................................................................................................... 4 3.6局限性..................................................................................................................................... 4 4所建议的系统................................................................................................................................ 4 4.1对所建议系统的说明 ............................................................................................................. 5 4.2处理流程和数据流程 ............................................................................................................. 5 5 4.3改进之处................................................................................................................................. 4.4影响......................................................................................................................................... 5 4.4.1对设备的影响 .................................................................................................................. 5 4.4.2对软件的影响 .................................................................................................................. 5 4.4.3对用户单位机构的影响 .................................................................................................. 5 4.4.4对系统运行过程的影响 .................................................................................................. 5 4.4.5对开发的影响 .................................................................................................................. 6 4.4.6 ...................................................................................................... 6 对地点和设施的影响 4.4.7 .......................................................................................................... 6 对经费开支的影响 4.5局限性..................................................................................................................................... 6 4.6技术条件方面的可行性 ......................................................................................................... 6 5可选择的其他系统 方案 气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载 ................................................................................................................ 6 5.1可选择的系统方案1 .............................................................................................................. 7 5.2可选择的系统方案2 .............................................................................................................. 7 6投资及效益分析............................................................................................................................ 7 6.1支出......................................................................................................................................... 7 6.1.1基本建设投资 .................................................................................................................. 7 6.1.2其他一次性支出 .............................................................................................................. 7 6.1.3非一次性支出 .................................................................................................................. 8 6.2收益......................................................................................................................................... 8 6.2.1一次性收益 ...................................................................................................................... 8 6.2.2非一次性收益 .................................................................................................................. 8 6.2.3不可定量的收益 .............................................................................................................. 8 6.3收益,投资比 ......................................................................................................................... 9 6.4投资回收周期 ......................................................................................................................... 9 6.5敏感性分析 ............................................................................................................................. 9 7社会因素方面的可行性................................................................................................................ 9 7.1法律方面的可行性 ................................................................................................................. 9 7.2使用方面的可行性 ................................................................................................................. 9 8结论 ............................................................................................................................................... 9 1 1引言 1.1 1.1编写目的 说明编写本可行性研究报告的目的,指出预期的读者。 1.2 1.2背景 说明: A. 所建议开发的软件系统的名称; B. 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络; C. 该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 1.4参考资料 列出用得着的参考资料,如: 1. 本项目的经核准的 计划 项目进度计划表范例计划下载计划下载计划下载课程教学计划下载 任务书或 合同 劳动合同范本免费下载装修合同范本免费下载租赁合同免费下载房屋买卖合同下载劳务合同范本下载 、上级机关的批文; 2. 属于本项目的其他已发表的文件; 3. 本文件中各处引用的文件、资料,包括所需用到的软件开发 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 。 列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的 来源。 2可行性研究的前提 说明对所建议的开发项目进行可行性研究的前提,如要求、目标、假定、限制等。 1.5 2.1要求 说明对所建议开发的软件的基本要求,如: A. 功能; B. 性能; C. 输出如报告、文件或数据,对每项输出要说明其特征,如用途、产生频度、接口以及分 发对象; 2 D. 输入说明系统的输入,包括数据的来源、类型、数量、数据的组织以及提供的频度; E. 处理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程,并辅之以叙 述; F. 在安全与保密方面的要求; G. 同本系统相连接的其他系统; H. 完成期限。 1.6 2.2目标 说明所建议系统的主要开发目标,如: A. 人力与设备费用的减少; B. 处理速度的提高; C. 控制精度或生产能力的提高; D. 管理信息服务的改进; E. 自动决策系统的改进; F. 人员利用率的改进。 1.7 2.3条件、假定和限制 说明对这项开发中给出的条件、假定和所受到的限制,如: a( 所建议系统的运行寿命的最小值; b( 进行系统方案选择比较的时间; c( 经费、投资方面的来源和限制; d( 法律和政策方面的限制; e( 硬件、软件、运行环境和开发环境方面的条件和限制; f( 可利用的信息和资源; g( 系统投入使用的最晚时间。 1.8 2.4进行可行性研究的方法 说明这项可行性研究将是如何进行的,所建议的系统将是如何评价的。摘要说明所使用 的基本方法 和策略,如调查、加权、确定模型、建立基准点或仿真等。 1.9 2.5评价尺度 说明对系统进行评价时所使用的主要尺度,如费用的多少、各项功能的优先次序、开发 时间的长短 及使用中的难易程度。 3 3对现有系统的分析 这里的现有系统是指当前实际使用的系统,这个系统可能是计算机系统,也可能是一个机械系统甚 至是一个人工系统。 分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 1.10 3.1处理流程和数据流程 说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示,并加以叙述。 1.11 3.2工作负荷 列出现有系统所承担的工作及工作量。 1.12 3.3费用开支 列出由于运行现有系统所引起的费用开支,如人力、设备、空间、支持性服务、材料等项开支以及开 支总额。 1.13 3.4人员 列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。 1.14 3.5设备 列出现有系统所使用的各种设备。 1.15 3.6局限性 列出本系统的主要的局限性,例如处理时间赶不上需要,响应不及时,数据存储能力不足,处理功能 不够等。并且要说明,为什么对现有系统的改进性维护已经不能解决问题。 4所建议的系统 本章将用来说明所建议系统的目标和要求将如何被满足。 4 1.16 4.1对所建议系统的说明 概括地说明所建议系统,并说明在第2章中列出的那些要求将如何得到满足,说明所使用的基本方法及理论根据。 1.17 4.2处理流程和数据流程 给出所建议系统的处理流程和数据流程。 1.18 4.3改进之处 按2.2条中列出的目标,逐项说明所建议系统相对于现存系统具有的改进。 1.19 4.4影响 说明在建立所建议系统时,预期将带来的影响,包括: 4.4.1对设备的影响 说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。 4.4.2对软件的影响 说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。 4.4.3对用户单位机构的影响 说明为了建立和运行所建议系统,对用户单位机构、人员的数量和技术水平等方面的全部要求。 4.4.4对系统运行过程的影响 说明所建议系统对运行过程的影响,如: a( 用户的操作规程; b( 运行中心的操作规程; c( 运行中心与用户之间的关系; d( 源数据的处理; e( 数据进入系统的过程; 5 f( 对数据保存的要求,对数据存储、恢复的处理; g( 输出报告的处理过程、存储媒体和调度方法; h( 系统失效的后果及恢复的处理办法。 4.4.5对开发的影响 说明对开发的影响,如: a. 为了支持所建议系统的开发,用户需进行的工作; b. 为了建立一个数据库所要求的数据资源; c. 为了开发和测验所建议系统而需要的计算机资源; d. 所涉及的保密与安全问题。 4.4.6对地点和设施的影响 说明对建筑物改造的要求及对环境设施的要求。 4.4.7对经费开支的影响 扼要说明为了所建议系统的开发,设计和维持运行而需要的各项经费开支。 1.20 4.5局限性 说明所建议系统尚存在的局限性以及这些问题未能消除的原因。 1.21 4.6技术条件方面的可行性 本节应说明技术条件方面的可行性,如: a( 在当前的限制条件下,该系统的功能目标能否达到; b( 利用现有的技术,该系统的功能能否实现; c( 对开发人员的数量和质量的要求并说明这些要求能否满足; d( 在规定的期限内,本系统的开发能否完成。 5可选择的其他系统方案 扼要说明曾考虑过的每一种可选择的系统方案,包括需开发的和可从国内国外直接购买 的,如果没有供选择的系统方案可考虑,则说明这一点。 6 1.22 5.1可选择的系统方案1 参照第4章的提纲,说明可选择的系统方案1,并说明它未被选中的理由。 1.23 5.2可选择的系统方案2 按类似5.1条的方式说明第2个乃至第n个可选择的系统方案。 ...... 6投资及效益分析 1.24 6.1支出 对于所选择的方案,说明所需的费用。如果已有一个现存系统,则包括该系统继续运行 期间所需的费用。 6.1.1基本建设投资 包括采购、开发和安装下列各项所需的费用,如: a. 房屋和设施; b. ADP设备; c. 数据通讯设备; d. 环境保护设备; e. 安全与保密设备; f. ADP操作系统的和应用的软件; g. 数据库管理软件。 6.1.2其他一次性支出 包括下列各项所需的费用,如: a( 研究(需求的研究和设计的研究); b( 开发计划与测量基准的研究; c( 数据库的建立; d( ADP软件的转换; e( 检查费用和技术管理性费用; f( 培训费、旅差费以及开发安装人员所需要的一次性支出; g( 人员的退休及调动费用等。 7 6.1.3非一次性支出 列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用,包括: a( 设备的租金和维护费用; b( 软件的租金和维护费用; c( 数据通讯方面的租金和维护费用; d( 人员的工资、奖金; e( 房屋、空间的使用开支; f( 公用设施方面的开支; g( 保密安全方面的开支; h( 其他经常性的支出等。 1.25 6.2收益 对于所选择的方案,说明能够带来的收益,这里所说的收益,表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等,包括; 6.2.1一次性收益 说明能够用人民币数目表示的一次性收益,可按数据处理、用户、管理和支持等项分类叙述,如: a( 开支的缩减包括改进了的系统的运行所引起的开支缩减,如资源要求的减少,运行 效率的改进,数据进入、存贮和恢复技术的改进,系统性能的可监控,软件的转换 和优化,数据压缩技术的采用,处理的集中化,分布化等; b( 价值的增升包括由于一个应用系统的使用价值的增升所引起的收益,如资源利用的 改进,管理和运行效率的改进以及出错率的减少等; c( 其他如从多余设备出售回收的收入等。 6.2.2非一次性收益 说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益,包括开支的减少和避免。 6.2.3不可定量的收益 逐项列出无法直接用人民币表示的收益,如服务的改进,由操作失误引起的风险的减少,信息掌握情况的改进,组织机构给外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计(按最好和最差情况估计)。 8 1.26 6.3收益,投资比 求出整个系统生命期的收益,投资比值。 1.27 6.4投资回收周期 求出收益的累计数开始超过支出的累计数的时间。 1.28 6.5敏感性分析 所谓敏感性分析是指一些关键性因素如系统生命期长度、系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时,对开支和收益的影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。 7社会因素方面的可行性 本章用来说明对社会因素方面的可行性分析的结果,包括: 1.29 7.1法律方面的可行性 法律方面的可行性问题很多,如合同责任、侵犯专利权、侵犯版权等方面的陷井,软件人员通常是不熟悉的,有可能陷入,务必要注意研究。 1.30 7.2使用方面的可行性 例如从用户单位的行政管理、工作制度等方面来看,是否能够使用该软件系统;从用户单位的工作人员的素质来看,是否能满足使用该软件系统的要求等等,都是要考虑的。 8结论 在进行可行性研究报告的编制时,必须有一个研究的结论。结论可以是: a( 可以立即开始进行; b( 需要推迟到某些条件(例如资金、人力、设备等)落实之后才能开始进行; c( 需要对开发目标进行某些修改之后才能开始进行; d( 不能进行或不必进行(例如因技术不成熟、经济上不合算等)。 9 2、软件需求说明书 1引言 1.1编写目的............................................................................................................................... 11 1.2背景....................................................................................................................................... 11 1.3定义....................................................................................................................................... 11 1.4参考资料............................................................................................................................... 11 2任务概述 11 2.1目标....................................................................................................................................... 2.2用户的特点 ........................................................................................................................... 12 2.3假定和约束 ........................................................................................................................... 12 3需求规定 3.1对功能的规定 ....................................................................................................................... 12 3.2对性能的规定 ....................................................................................................................... 12 3.2.1精度................................................................................................................................ 12 3.2.2时间特性要求 ................................................................................................................ 12 3.2.3灵活性............................................................................................................................ 12 3.3输人输出要求 ....................................................................................................................... 13 3.4数据管理能力要求 ............................................................................................................... 13 3.5故障处理要求 ....................................................................................................................... 13 3.6其他专门要求 ....................................................................................................................... 134运行环境规定 4.1设备....................................................................................................................................... 13 4.2支持软件............................................................................................................................... 13 4.3接口....................................................................................................................................... 14 4.4控制....................................................................................................................................... 14 10 1引言 1.31 1.1编写目的 说明编写这份软件需求说明书的目的,指出预期的读者。 1.32 1.2背景 说明: a( 待开发的软件系统的名称; b( 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络; c( 该软件系统同其他系统或其他机构的基本的相互来往关系。 1.33 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.34 1.4参考资料 列出用得着的参考资料,如: a( 本项目的经核准的计划任务书或合同、上级机关的批文; b( 属于本项目的其他已发表的文件; c( 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资 料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2任务概述 1.35 2.1目标 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。| 11 1.36 2.2用户的特点 列出本软件的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,以及本软件的预期使甩频度。这些是软件设计工作的重要约束 1.37 2.3假定和约束 列出进行本软件开发工作的假定和约束,例如经费限制、开发期限等。 3需求规定 1.38 3.1对功能的规定 用列表的方式(例如IPO表即输入、处理、输出表的形式),逐项定量和定性地叙述对软件所提出的功能要求,说明输入什么量、经怎样的处理、得到什么输出,说明软件应支持的终端数和应支持的并行操作的用户数。 1.39 3.2对性能的规定 3.2.1精度 说明对该软件的输入、输出数据精度的要求,可能包括传输过程中的精度。 3.2.2时间特性要求 说明对于该软件的时间特性要求,如对: a( 响应时间; b( 更新处理时间; c( 数据的转换和传送时间; d( 解题时间;等的要求。 3.2.3灵活性 说明对该软件的灵活性的要求,即当需求发生某些变化时,该软件对这些变化的适应能力,如: a( 操作方式上的变化; b( 运行环境的变化; c( 同其他软件的接口的变化; 12 d( 精度和有效时限的变化; e( 计划的变化或改进。 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。 1.40 3.3输人输出要求 解释各输入输出数据类型,并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例,包括对硬拷贝报告(正常结果输出、状态输出及异常输出)以及图形或显示报告的描述。 1.41 3.4数据管理能力要求 说明需要管理的文卷和记录的个数、表和文卷的大小规模,要按可预见的增长对数据及其分量的存储要求作出估算。 1.42 3.5故障处理要求 列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。 1.43 3.6其他专门要求 如用户单位对安全保密的要求,对使用方便的要求,对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。 4运行环境规定 1.44 4.1设备 列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能,包括: a( 处理器型号及内存容量; b( 外存容量、联机或脱机、媒体及其存储格式,设备的型号及数量; c( 输入及输出设备的型号和数量,联机或脱机; d( 数据通信设备的型号和数量; e( 功能键及其他专用硬件 1.45 4.2支持软件 列出支持软件,包括要用到的操作系统、编译(或汇编)程序、测试支持软件等。 13 1.46 4.3接口 说明该软件同其他软件之间的接口、数据通信协议等。 1.47 4.4控制 说明控制该软件的运行的方法和控制信号,并说明这些控制信号的来源。 14 3、项目开发计划 1引言 ............................................................................................................................................. 16 1.1编写目的............................................................................................................................... 16 1.2 背景 ...................................................................................................................................... 16 1.3定义....................................................................................................................................... 16 1.4参考资料............................................................................................................................... 16 2项目概述 ..................................................................................................................................... 16 2.1工作内容............................................................................................................................... 16 2.2主要参加人员 ....................................................................................................................... 16 2.3产品....................................................................................................................................... 17 2.3.1程序................................................................................................................................ 17 2.3.2文件................................................................................................................................ 17 2.3.3服务................................................................................................................................ 17 2.3.4非移交的产品 ................................................................................................................ 17 2.4验收标准............................................................................................................................... 17 2.5完成项目的最迟期限 ........................................................................................................... 17 2.6本计划的批准者和批准日期 ............................................................................................... 17 3实施计划 ..................................................................................................................................... 17 3.1工作任务的分解与人员分工 ............................................................................................... 17 3.2接口人员............................................................................................................................... 18 3.3进度....................................................................................................................................... 18 3.4预算....................................................................................................................................... 18 3.5关键问题............................................................................................................................... 18 4支持条件 ..................................................................................................................................... 18 4.1计算机系统支持 ................................................................................................................... 18 4.2需由用户承担的工作 ........................................................................................................... 18 4.3由外单位提供的条件 ........................................................................................................... 19 5专题计划要点.............................................................................................................................. 19 15 1引言 1.48 1.1编写目的 说明:编写这份软件项目开发计划的目的,并指出预期的读者。 1.49 1.2 背景 说明: a. 待开发的软件系统的名称; b. 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络; c. 该软件系统同其他系统或其他机构的基本的相互来往关系。 1.50 1.3定义 列出本文件中用到的专门术语的定义和外文的首字母组词的原词组。 1.51 1.4参考资料 列出用得着的参考资料,如: a. 本项目的经核准的计划任务书和合同、上级机关的批文; b. 属于本项目的其他已发表的文件; c. 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件资 料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2项目概述 1.52 2.1工作内容 简要地说明在本项目的开发中须进行的各项主要工作。 1.53 2.2主要参加人员 扼要说明参加本项目开发的主要人员的情况,包括他们的技术水平。 16 1.54 2.3产品 2.3.1程序 列出须移交给用户的程序的名称、所用地编程语言及存储程序的媒体形式,并通过引用相关文件,逐项说明其功能和能力。 2.3.2文件 列出须移交用户的每种文件的名称及内容要点。 2.3.3服务 列出需向用户提供的各项服务,如培训安装、维护和运行支持等,应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品(文件甚至某些程序)。 1.55 2.4验收标准 对于上述这些应交出的产品和服务,逐项说明或引用资料说明验收标准。 1.56 2.5完成项目的最迟期限 1.57 2.6本计划的批准者和批准日期 3实施计划 1.58 3.1工作任务的分解与人员分工 对于项目开发中需要完成的各项工作,从需求分析、设计、实现、测试直到维护,包括文件的编制、审批、打印、分发工作,用户培训工作,软件安装工作等,按层次进行分解,指明每项任务的负责人和参加人员。 17 1.59 3.2接口人员 说明负责接口工作的人员及他们的职责,包括: a. 负责本项目同用户的接口人员; b. 负责本项目同本单位各管理机构,如合同计划管理部门、财务部门、质量管理部门 等的接口人员; c. 负责本项目同个份合同负责单位的接口人员等。 1.60 3.3进度 对于需求分析、设计、编码实现、测试、移交、培训和安装等工作,给出每项工作任务的预定开始日期、完成日期及所需资源,规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件(即所谓“里程碑)。 1.61 3.4预算 逐项列出本开发项目所需要的劳务(包括人员的数量和时间)以及经费的预算(包括办公费、差旅费、机时费、资料费、通讯设备和专用设备的租金等)和来源。 1.62 3.5关键问题 逐项列出能够影响整个项目成败的关键问题、技术难点和风险,指出这些问题对项目的影响。 4支持条件 说明为支持本项目的开发所需要的各种条件和设施。 1.63 4.1计算机系统支持 逐项列出开发中和运行时所需的计算机系统支持,包括计算机、外围设备、通讯设备、模拟器、编译(或汇编)程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等,逐项给出有关到货日期、使用时间的要求。 1.64 4.2需由用户承担的工作 逐项列出需要用户承担的工作和完成期限。包括需由用户提供的条件及提供时间。 18 1.65 4.3由外单位提供的条件 逐项列出需要外单位分合同承包者承担的工作和完成的时间,包括需要由外单位提供的条件和提供的时间。 5专题计划要点 说明本项目开发中需制定的各个专题计划(如分合同计划、开发人员培训计划、测试计划、安全保密计划、质量保证计划、配置管理计划、用户培训计划、系统安装计划等)的要点。 19 4、概要设计说明书 1引言 ............................................................................................................................................. 21 1.1编写目的............................................................................................................................... 21 1.2背景....................................................................................................................................... 21 1.3定义....................................................................................................................................... 21 1.4参考资料............................................................................................................................... 21 2总体设计 ..................................................................................................................................... 21 2.1需求规定............................................................................................................................... 21 2.2运行环境............................................................................................................................... 21 2.3基本设计概念和处理流程 ................................................................................................... 22 2.4结构....................................................................................................................................... 22 2.5功能器求与程序的关系 ....................................................................................................... 22 2.6人工处理过程 ....................................................................................................................... 22 2.7尚未问决的问题 ................................................................................................................... 22 3接口设计 ..................................................................................................................................... 22 3.1用户接口............................................................................................................................... 22 3.2外部接口............................................................................................................................... 22 3.3内部接口............................................................................................................................... 23 4运行设计 ..................................................................................................................................... 23 4.1运行模块组合 ....................................................................................................................... 23 4.2运行控制............................................................................................................................... 23 4.3运行时间............................................................................................................................... 23 5系统数据结构设计...................................................................................................................... 23 5.1逻辑结构设计要点 ............................................................................................................... 23 5.2物理结构设计要点 ............................................................................................................... 23 5.3数据结构与程序的关系 ....................................................................................................... 23 6系统出错处理设计...................................................................................................................... 24 6.1出错信息............................................................................................................................... 24 6.2补救措施............................................................................................................................... 24 6.3系统维护设计 ....................................................................................................................... 24 20 1引言 1.66 1.1编写目的 说明编写这份概要设计说明书的目的,指出预期的读者。 1.67 1.2背景 说明: a. 待开发软件系统的名称; b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。 1.68 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.69 1.4参考资料 列出有关的参考文件,如: a. 本项目的经核准的计划任务书或合同,上级机关的批文; b. 属于本项目的其他已发表文件; c. 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的 标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2总体设计 1.70 2.1需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求,详细的说明可参见附录C。 1.71 2.2运行环境 简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定,详细说明参见附录C。 21 1.72 2.3基本设计概念和处理流程 说明本系统的基本设计概念和处理流程,尽量使用图表的形式。 1.73 2.4结构 用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系. 1.74 2.5功能器求与程序的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系: 程序1 程序2 „„ 程序n 功能需求1 ? 功能需求2 ? „„ 功能需求n ? ? 1.75 2.6人工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。 1.76 2.7尚未问决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。 3接口设计 1.77 3.1用户接口 说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。 1.78 3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。 22 1.79 3.3内部接口 说明本系统之内的各个系统元素之间的接口的安排。 4运行设计 1.80 4.1运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运 行所历经的内部模块和支持软件。 1.81 4.2运行控制 说明每一种外界的运行控制的方式方法和操作步骤。 1.82 4.3运行时间 说明每种运行模块组合将占用各种资源的时间。 5系统数据结构设计 1.83 5.1逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、 文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 1.84 5.2物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、 存取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。 1.85 5.3数据结构与程序的关系 说明各个数据结构与访问这些数据结构的形式。 23 6系统出错处理设计 1.86 6.1出错信息 用一览表的方式说朗每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。 1.87 6.2补救措施 说明故障出现后可能采取的变通措施,包括: a. 后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立 和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种 后备技术; b. 降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需 结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记 录; c. 恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软 件从头开始重新运行的方法。 1.88 6.3系统维护设计 说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系。 24 5、详细设计说明书 1引言 ............................................................................................................................................. 26 1.1编写目的............................................................................................................................... 26 1.2背景....................................................................................................................................... 26 1.3定义....................................................................................................................................... 26 1.4参考资料............................................................................................................................... 26 2程序系统的结构.......................................................................................................................... 26 3程序1(标识符)设计说明....................................................................................................... 26 3.1程序描述............................................................................................................................... 27 3.2功能....................................................................................................................................... 27 3.3性能....................................................................................................................................... 27 3.4输人项................................................................................................................................... 27 3.5输出项................................................................................................................................... 27 3.6算法....................................................................................................................................... 27 3.7流程逻辑............................................................................................................................... 27 3.8接口....................................................................................................................................... 27 3.9存储分配............................................................................................................................... 28 3.10注释设计 ............................................................................................................................. 28 3.11限制条件 ............................................................................................................................. 28 3.12测试计划 ............................................................................................................................. 28 3.13尚未解决的问题 ................................................................................................................. 28 4程序2(标识符)设计说明....................................................................................................... 28 25 1引言 1.89 1.1编写目的 说明编写这份详细设计说明书的目的,指出预期的读者。 1.90 1.2背景 说明: a( 待开发软件系统的名称; b( 本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。 1.91 1.3定义 列出本文件中用到专门术语的定义和外文首字母组词的原词组。 1.92 1.4参考资料 列出有关的参考资料,如: a( 本项目的经核准的计划任务书或合同、上级机关的批文; b( 属于本项目的其他已发表的文件; c( 本文件中各处引用到的文件资料,包括所要用到的软件开发标准。列出这些文件的 标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。 2程序系统的结构 用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间 的层次结构关系。 3程序1(标识符)设计说明 从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。 26 1.93 3.1程序描述 给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻,是否子程序,是可重人的还是不可重人的,有无覆盖要求,是顺序处理还是并发处理等)。 1.94 3.2功能 说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。 1.95 3.3性能 说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。 1.96 3.4输人项 给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 1.97 3.5输出项 给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。 1.98 3.6算法 详细说明本程序所选用的算法,具体的计算公式和计算步骤。 1.99 3.7流程逻辑 用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。 1.100 3.8接口 用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。 27 1.101 3.9存储分配 根据需要,说明本程序的存储分配。 1.102 3.10注释设计 说明准备在本程序中安排的注释,如: a( 加在模块首部的注释; b( 加在各分枝点处的注释; c( 对各变量的功能、范围、缺省条件等所加的注释; d( 对使用的逻辑所加的注释等等。 1.103 3.11限制条件 说明本程序运行中所受到的限制条件。 1.104 3.12测试计划 说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进 度安排、人员职责、设备条件驱动程序及桩模块等的规定。 1.105 3.13尚未解决的问题 说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。 4程序2(标识符)设计说明 用类似F(3的方式,说明第2个程序乃至第N个程序的设计考虑。 28 6、测试计划 1引言 1.106 1.1编写目的 本测试计划的具体编写目的,指出预期的读者范围。 1.107 1.2背景 说明: a( 测试计划所从属的软件系统的名称; b( 该开发项目的历史,列出用户和执行此项目测试的计算中心,说明在开始执行本测 试计划之前必须完成的各项工作。 1.108 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.109 1.4参考资料 列出要用到的参考资料,如: a( 本项目的经核准的计划任务书或合同、上级机关的批文; b( 属于本项目的其他已发表的文件; c( 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的 标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2计划 1.110 2.1软件说明 提供一份图表,并逐项说明被测软件的功能、输入和输出等质量指标,作为叙述测试计 划的提纲。 29 1.111 2.2测试内容 列出组装测试和确认测试中的每一项测试内容的名称标识符、这些测试的进度安排以及这些测试的内容和目的,例如模块功能测试、接口正确性测试、数据文卷存取的测试、运行时间的测试、设计约束和极限的测试等。 1.112 2.3测试1(标识符) 给出这项测试内容的参与单位及被测试的部位。 2.3.1进度安排 给出对这项测试的进度安排,包括进行测试的日期和工作内容(如熟悉环境。培训、准备输入数据等)。 2.3.2条件 陈述本项测试工作对资源的要求,包括: a( 设备所用到的设备类型、数量和预定使用时间; b( 软件列出将被用来支持本项测试过程而本身又并不是被测软件的组成部分的软件, 如测试驱动程序、测试监控程序、仿真程序、桩模块等等; c( 人员列出在测试工作期间预期可由用户和开发任务组提供的工作人员的人数。技术 水平及有关的预备知识,包括一些特殊要求,如倒班操作和数据键入人员。 2.3.3测试资料 列出本项测试所需的资料,如: a( 有关本项任务的文件; b( 被测试程序及其所在的媒体; c( 测试的输入和输出举例; d( 有关控制此项测试的方法、过程的图表。 2.3.4测试培训 说明或引用资料说明为被测软件的使用提供培训的计划。规定培训的内容、受训的人员及从事培训的工作人员。 30 1.113 2.4测试2(标识符) 用与本测试计划2.3条相类似的方式说明用于另一项及其后各项测试内容的测试 工作计划 幼儿园家访工作计划关于小学学校工作计划班级工作计划中职财务部门工作计划下载关于学校后勤工作计划 。 3测试设计说明 1.114 3.1测试1(标识符) 说明对第一项测试内容的测试设计考虑。 3.1.1控制 说明本测试的控制方式,如输入是人工、半自动或自动引入、控制操作的顺序以及结果的记录方法。 3.1.2输入 说明本项测试中所使用的输入数据及选择这些输入数据的策略。 3.1.3输出 说明预期的输出数据,如测试结果及可能产生的中间结果或运行信息。 1.115 3.1.4过程 说明完成此项测试的一个个步骤和控制命令,包括测试的准备、初始化、中间步聚和运行结束方式。 1.116 3.2测试2(标识符) 用与本测试计划3.l条相类似的方式说明第2项及其后各项测试工作的设计考虑。 31 4评价准则 1.117 4.1范围 说明所选择的测试用例能够接查的范围及其局限性。 1.118 4.2数据整理 陈述为了把测试数据加工成便于评价的适当形式,使得测试结果可以同,已知结果进行比较而要用到的转换处理技术,如手工方式或自动方式;如果是用自动方式整理数据,还要说明为进行处理而要用到的硬件、软件资源。 1.119 4.3尺度 说明用来判断测试工作是否能通过的评价尺度,如合理的输出结果的类型、测试输出结果与预期输出之间的容许偏离范围、允许中断或停机的最大次数。 32 7、测试分析报告 1引言 1.120 1.1编写目的 说明这份测试分析报告的具体编写目的,指出预期的阅读范围。 1.121 1.2背景 说明: a. 被测试软件系统的名称; b. 该软件的任务提出者、开发者、用户及安装此软件的计算中心,指出测试环境与实 际运行环境 之间可能存在的差异以及这些差异对测试结果的影响。 1.122 1.3定义 列出本文件中用到的专问术语的定义和外文首字母组词的原词组。 1.123 1.4参考资料 列出要用到的参考资料,如: a( 本项目的经核准的计划任务书或合同、上级机关的批文; b( 属于本项目的其他已发表的文件; c( 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的 标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2测试概要 用表格的形式列出每一项测试的标识符及其测试内容,并指明实际进行的测试工作内容 与测试计划中预先设计的内容之间的差别,说明作出这种改变的原因。 33 3测试结果及发现 1.124 3.1测试1(标识符) 把本项测试中实际得到的动态输出(包括内部生成数据输出)结果同对于动态输出的要求进行比较,陈述其中的各项发现。 1.125 3.2测试2(标识符) 用类似本报告3.1条的方式给出第 2项及其后各项测试内容的测试结果和发现。 4对软件功能的结论 1.126 4.1功能1(标识符) 4.1.1能力 简述该项功能,说明为满足此项功能而设计的软件能力以及经过一项或多项测试已证实的能力。 4.1.2限制 说明测试数据值的范围(包括动态数据和静态数据),列出就这项功能而言,测试期间在该软件中查出的缺陷、局限性。 1.127 4.2功能2(标识符) 用类似本报告4.l的方式给出第2项及其后各项功能的测试结论。 (((((( 34 5分析摘要 1.128 5.1能力 陈述经测试证实了的本软件的能力。如果所进行的测试是为了验证一项或几项特定性能要求的实现,应提供这方面的测试结果与要求之间的比较,并确定测试环境与实际运行环境之间可能存在的差异 对能力的测试所带来的影响。 1.129 5.2缺陷和限制 陈述经测试证实的软件缺陷和限制,说明每项缺陷和限制对软件性能的影响,并说明全部测得的性能缺陷的累积影响和总影响。 1.130 5.3建议 对每项缺陷提出改进建议,如: a( 各项修改可采用的修改方法; b( 各项修改的紧迫程度; c( 各项修改预计的工作量; d( 各项修改的负责人。 1.131 5.4评价 说明该项软件的开发是否已达到预定目标,能否交付使用。 6测试资源消耗 总结测试工作的资源消耗数据,如工作人员的水平级别数量、机时消耗等。 35 8、操作手册(GB8567——88) 1引言 ............................................................................................................................................. 37 1.1编写目的............................................................................................................................... 37 1.2前景....................................................................................................................................... 37 1.3定义....................................................................................................................................... 37 1.4参考资料............................................................................................................................... 37 2软件征述 ..................................................................................................................................... 37 2.1软件的结构 ........................................................................................................................... 37 2.2程序表................................................................................................................................... 37 2.3文卷表................................................................................................................................... 38 3安装与初始化.............................................................................................................................. 38 4运行说明 ..................................................................................................................................... 38 4.1运行表................................................................................................................................... 38 4.2运行步骤............................................................................................................................... 38 4.3运行1(标识符)说明 ........................................................................................................ 38 4.3.1运行控制 ........................................................................................................................ 38 4.3.2操作信息 ........................................................................................................................ 38 4.3.3输入一输出文卷 ............................................................................................................ 39 4.3.4输出文段 ........................................................................................................................ 39 4.3.5输出文段的复制 ............................................................................................................ 39 4.3.6恢复过程 ........................................................................................................................ 39 4.4运行2(标识符)说明 ........................................................................................................ 39 5非常规过程.................................................................................................................................. 40 6远程操作 ..................................................................................................................................... 40 36 1引言 1.132 1.1编写目的 说明编写这份操作手册的目的,指出预期的读者。 1.133 1.2前景 说明: a( 这份操作手册所描述的软件系统的名称; b( 该软件项目的任务提出者、开发者、用户(或首批用户)及安装该软件的计算中心。 1.134 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.135 1.4参考资料 列出有用的参考资料,如: a( 本项目的经核准的计划任务书或合同、上级机关的批文; b( 属于本项目的其他已发表的文件; c( 本文件中各处引用的文件、资料,包括所列出的这些文件资料的标题、文件编号、 发表日期和出版单位,说明能够得到这些文件资料的来源。 2软件征述 1.136 2.1软件的结构 结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。 1.137 2.2程序表 列出本系统内每个程序的标识符、编号和助记名。 37 1.138 2.3文卷表 列出将由本系统引用、建立或更新的每个永久性文卷,说明它们各自的标识符、编号、助记名、存储媒体和存储要求。 3安装与初始化 一步一步地说明为使用本软件而需要进行的安装与初始化过程,包括程序的存载形式,安装与初始化过程中的全部操作命令,系统对这些命令的反应与答复,表征安装工作完成的测试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。 4运行说明 所谓一个运行是指提供一个启动控制信息后,直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。 1.139 4.1运行表 列出每种可能的运行,摘要说明每个运行的目的,指出每个运行各自所执行的程序。 1.140 4.2运行步骤 说明从一个运行转向另一个运行以完成整个系统运行的步骤。 1.141 4.3运行1(标识符)说明 把运行1的有关信息,以对操作人员为最方便最有用的形式加以说明。 4.3.1运行控制 列出为本运行所需要”的运行流向控制的说明。 4.3.2操作信息 给出为操作中心的操作人员和管理人员所需要的信息,如: a. 运行目的; b. 操作要求; 38 c. 启动方法 如应请启动(由所遇到的请求信息启动)、预定时间启动、„,??等; d. 预计的运行时间和解题时间; e. 操作命令; f. 与运行有联系的其他事项。 4.3.3输入一输出文卷 提供被本运行建立、更新或访问的数据文卷的有关信息,如: a. 文卷的标识符或标号; b. 记录媒体; c. 存留的目录表; d. 文卷的支配如确定保留或废弃的准则、是否要分配给其他接受者、占用硬设备的优 先级以及保密控制等有关规定。 4.3.4输出文段 提供本软件输出的每一一个用于提示、说明、或应答的文段(包括“菜单”)的有关信 息,如: a. 文段的标识符; b. 输出媒体(屏幕显示、打印、„„); c. 文字容量; d. 分发对象; e. 保密要求。 4.3.5输出文段的复制 对由计算机产生,而后需用其他方法复制的那些文段提供有关信息,如: a. 文段的标识符; b. 复制的技术手段; c. 纸张或其他媒体的规格; d. 装订要求; e. 分发对象; f. 复制份数。 4.3.6恢复过程 说明本运行故障后的恢复过程。 1.142 4.4运行2(标识符)说明 用与本手册4.3条相类似的方式介绍另一个运行的有关信息。 39 5非常规过程 提供有关应急操作或非常规操作的必要信息,如出错处理操作、向后备系统的切换操作以及其他必须向程序维护人员交待的事项和步骤。 6远程操作 如果本软件能够通过远程终端控制运行,则在本章说明通过远程终端运行本软件的操作过程。 40
本文档为【软件开发文档指南】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
is_014457
暂无简介~
格式:doc
大小:109KB
软件:Word
页数:55
分类:生活休闲
上传时间:2018-09-26
浏览量:40