《软件工程项目文档模板.doc》由会员分享,可在线阅读,更多相关《软件工程项目文档模板.doc(19页珍藏版)》请在金锄头文库上搜索。
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、4.3 改进之处 按2.2条中列出的目标,逐项说明所建议系统相对于现存系统具有的改进。4.4 影响 说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。4.4.1.对设备的影响 说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改4.4.2.对软件的影响 说明为了使现存的应用软件和支持软件能够同所建议系统相适应,而需要对这些软件所进行的修改和补充。4.4.3.对用户单位机构的影响 说明为了建立和运行所建议系统,对用户单位机构、人员的数量和技术水平等方面的全部要求。4.4.4.对系统运行过程的影响 说明所建议系统对运行过程的影响。4.4.5.对开发的影响 说明对开发的影响。4.
5、4.6.对地点和设施的影响 说明对建筑物改造的要求及对环境设施的要求。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控制 说明控制该系统的运行的方法和控制信号,并说明这些控制信号的来源。三、项目计划书编者说明: 随着现代软件工程思想的普及,迭代的、增量的开发生命周期已经被认识并付诸实践,针对这样的生命周期,其项目计划的格式也需要做出相应的调整。1
12、. 文档概述在此对整个文档进行概要性描述,另外还应列出该计划的目标、范围、定义、术语、参考资料等内容。1.1 目标在此描述本项目计划的目标。1.2 范围 简要说明该计划所覆盖的范围,以及与其相关的项目,与该文档有联系的事物。1.3 定义与术语在此列出在该计划中所涉及的所有术语、定义、缩写词的解释,这些信息也可以引用项目词汇表来提供。1.4 参考资料在此应列出项目计划中引用的文档列表,对于引用的每个文档都应该列出其标题、文档编号、日期,并且指出这些文档的来源,以方便该计划的阅读者查找。1.5 概述 说明该计划其它部分所包含的内容,以及文档的组织方式。2. 项目概述项目目标指出该项目将会交付什么样
13、的产品,能够帮助客户达到什么目标。假设与约束列举出制定该计划时所做的所有假设,以及列举出对该项目的解决方案的约束性要求,如特定的操作系统平台、特定的时间、特定的经费范围等。项目交付物具体列出该项目完成后,将交付哪些东西,并可以列出每个交付时间。项目计划更新总结建议采用表格的形式,将计划的修订过程列出来。3. 项目组织项目组织结构建议使用组织结构图的形式,将整个项目团队成员之间的关系与职责明确下来,甚至可以包括管理人员、各种委员会等。外部联系人列出开发组织之外的,所有与项目相关的外部人员的姓名、联系电话等资料。角色与职责明确项目开发各个任务的负责人或小组。4. 项目管理计划项目估计给出关于项目成本、进度的估计值,这些估计值将是项目计划制定的基础,也是今后重新评估、修改计划的基础。你可以采用任何估算技术。项目计划4.2.1 阶段计划主要包括工作结构分解(WBS)、显示各个阶段或迭代时间安排的甘特图、主要里程碑与其验收标准。4.2.2 迭代目标如果你采用的是迭代式的开发方法,那么在此列出每次迭代的计划,以及每次迭代计划实现的目标。4.2.3 发行计划列出软件开发过程中各个中间版本的发行时间,包括演示版、Alpha版、Beta版等。4.2.4 项目进度表使用甘特图或PERT图等方法,表示出该项目的进度计划。4.