软件工程报告模板.docx

1、软件工程报告模板软件工程报告模板（目录提纲)软件工程报告模板 一、可行性研究报告一、可行性研究报告11引言21.1编写目的21.2项目背景21.3定义21.4参考资料22可行性研究的前提22.1要求22.2目标32.3条件、假定和限制32.4可行性研究方法32.5决定可行性的主要因素33对现有系统的分析33.1处理流程和数据流程33.2工作负荷33.3费用支出33.4人员33.5设备33.6局限性34所建议技术可行性分析34.1对系统的简要描述34.2处理流程和数据流程34.3与现有系统比较的优越性34.4采用建议系统可能带来的影响34.5技术可行性评价35所建议系统经济可行性分析35.1支出

2、35.2效益35.3收益/投资比35.4投资回收周期35.5敏感性分析36社会因素可行性分析36.1法律因素36.2用户使用可行性37其他可供选择的方案31引言1.1编写目的【阐明编写可行性研究报告的目的，指明读者对象。】1.2项目背景【应包括： 所建议开发软件的名称；项目的任务提出者、开发者、用户及实现软件的单位；项目与其他软件或其他系统的关系。】1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： 项目经核准的计划任务书、合同或上级机关的批文；与项目有关的已发表的资料；文档中所引用的资料，所采用

3、的软件标准或规范。】2可行性研究的前提2.1要求【列出并说明建议开发软件的基本要求，如功能；性能；输出；输入；基本的数据流程和处理流程；安全与保密要求；与软件相关的其他系统；完成期限。】2.2目标【可包括：人力与设备费用的节省；处理速度的提高；控制精度或生产能力的提高；管理信息服务的改进；决策系统的改进；人员工作效率的提高，等等。】2.3条件、假定和限制【可包括：建议开发软件运行的最短寿命；进行系统方案选择比较的期限；经费来源和使用限制；法律和政策方面的限制；硬件、软件、运行环境和开发环境的条件和限制；可利用的信息和资源；建议开发软件投入使用的最迟时间。】2.4可行性研究方法2.5决定可行性的

4、主要因素3对现有系统的分析3.1处理流程和数据流程3.2工作负荷3.3费用支出【如人力、设备、空间、支持性服务、材料等项开支。】3.4人员【列出所需人员的专业技术类别和数量。】3.5设备3.6局限性【说明现有系统存在的问题以及为什么需要开发新的系统。】4所建议技术可行性分析4.1对系统的简要描述4.2处理流程和数据流程4.3与现有系统比较的优越性4.4采用建议系统可能带来的影响4.4.1对设备的影响4.4.2对现有软件的影响4.2.3对用户的影响4.2.4对系统运行的影响4.2.5对开发环境的影响4.2.6对运行环境的影响4.2.7对经费支出的影响4.5技术可行性评价【包括：在限制条件下，功能

5、目标是否能达到；利用现有技术，功能目标能否达到；对开发人员数量的和质量的要求，并说明能否满足；在规定的期限内，开发能否完成。】5所建议系统经济可行性分析5.1支出5.1.1基建投资5.1.2其他一次性支出5.1.3经常性支出5.2效益5.2.1一次性收益5.2.2经常性收益5.2.3不可定量收益5.3收益/投资比5.4投资回收周期5.5敏感性分析【敏感性分析是指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。】6社会因素可行性分析6.1法律因素【如，合同责任、侵犯专利权、侵犯版权等问题的分析。】6.2用户使用可行性【如，用户单位

6、的行政管理、工作制度、人员素质等能否满足要求。】7其他可供选择的方案【逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。】8.结论意见【结论意见可能是：可着手组织开发；需待若干条件（如资金、人力、设备等）具备后才能开发；需对开发目标进行某些修改；不能进行或不必进行（如技术不成熟，经济上不合算等）；其他。】二、需求规格说明书1引言11.1编写目的11.2项目背景21.3定义21.4参考资料22任务概述22.1目标22.2运行环境22.3条件与限制23数据描述33.1静态数据33.2动态数据33.3数据库介绍33.4数据词典33.5数据采集34功能需求34.1功能划分34.2功能描述35性能需

7、求35.1数据精确度35.2时间特性35.3适应性36运行需求36.1用户界面36.2硬件接口36.3软件接口36.4故障处理37其它需求31引言1.1编写目的【阐明编写需求说明书的目的，指明读者对象。】为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。本文档供项目经理、设计人员、开发人员参考。1.2项目背景项目的委托单位、开发单位和主管部门该软件系统与其他1.3定义【列出文当中所用到的专门术语的定义和缩写词的原文。】1.4参考资料项目经核准的计划任务书、合同或上级机关的批文项目开发计划文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

8、2任务概述2.1目标2.2运行环境操作系统：Microsoft Windows 2000 Advanced Server支持环境：IIS 5.0数 据 库：Microsoft SQL Server 20002.3条件与限制3数据描述3.1静态数据3.2动态数据【包括输入数据和输出数据。】3.3数据库介绍【给出使用数据库的名称和类型。】3.4数据词典3.5数据采集4功能需求4.1功能划分4.2功能描述5性能需求5.1数据精确度5.2时间特性【如响应时间、更新处理时间、数据转换与传输时间、运行时间等。】5.3适应性【在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的适应能力。

9、】6运行需求6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。】6.2硬件接口6.3软件接口6.4故障处理7其它需求【如可使用性、安全保密、可维护性、可移植性等。】三、概要设计说明书1引言21.1编写目的21.2项目背景21.3定义21.4参考资料22任务概述32.1目标32.2运行环境32.3需求概述32.4条件与限制33总体设计33.1处理流程33.2总体结构和模块外部设计33.3功能分配34接口设计34.1外部接口34.2内部接口35数据结构设计35.1逻辑结构设计35.2物理结构设计35.3数据结构与程序的关系36运行设计36.1运行模块的组合36.2运行控制36.3运行

10、时间37出错处理设计37.1出错输出信息37.2出错处理对策38.安全保密设计39.维护设计31引言1.1编写目的【阐明编写概要设计说明书的目的，指明读者对象。】1.2项目背景【应包括： 项目的委托单位、开发单位和主管部门；该软件系统与其他系统的关系。】1.3定义【列出本文档中所用到的专门术语的定义和缩写词的原文。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： 项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册（初稿）；文档所引用的资料、采用的标准或规范。】2任务概述2.1目标2.2运行环境2.3

11、需求概述2.4条件与限制3总体设计3.1处理流程3.2总体结构和模块外部设计3.3功能分配【表明各项功能与程序结构的关系。】4接口设计 4.1外部接口【包括用户界面、软件接口与硬件接口。】4.2内部接口【模块之间的接口。】5数据结构设计5.1逻辑结构设计5.2物理结构设计5.3数据结构与程序的关系6运行设计6.1运行模块的组合6.2运行控制6.3运行时间7出错处理设计7.1出错输出信息7.2出错处理对策【如设置后备、性能降级、恢复及再启动等。】8.安全保密设计9.维护设计【说明为方便维护工作的设施，如维护模块等。】四、用户操作手册1引言11.1编写目的11.2项目背景21.3定义21.4参考资

12、料22软件概述22.1目标22.2功能22.3性能23运行环境23.1硬件23.2支持软件34.使用说明34.1安装和初始化34.2输入34.3输出34.4出错和恢复34.5求助查询35.运行说明35.1运行表35.2运行步骤36.非常规过程37.操作命令一览表38.程序文件（或命令文件）和数据文件一览表39.用户操作举例31引言1.1编写目的【阐明编写手册的目的，指明读者对象。】1.2项目背景【应包括项目的来源、委托单位、开发单位和主管部门。】1.3定义【列出手册中所用到的专门术语的定义和缩写词的原文。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

13、项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划；手册中引用的其他资料、采用的软件工程标准或软件工程规范。】2软件概述2.1目标2.2功能2.3性能数据精确度【包括输入、输出及处理数据的精度。】时间特性【如响应时间、处理时间、数据传输时间等。】灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】3运行环境3.1硬件【列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量；外存储器、媒体、记录格式、设备型号及数量；输入、输出设备；数据传输设备及数据转换设备的型号及数量。】3.2支持软件【如：操作系统名称及版本号；语言编译系统或汇编

14、系统的名称及版本号；数据库管理系统的名称及版本号；其他必要的支持软件。】4.使用说明4.1安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。】4.2输入【给出输入数据或参数的要求。】4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。】4.2.2数据格式【如：长度；格式基准；标号；顺序；分隔符；词汇表；省略和重复；控制。】4.2.3输入举例4.3输出【给出每项输出数据的说明。】4.3.1数据背景【说明输出数据的去向、使用频度、存放媒体及质量管理等。】4.3.2数据格式【详细阐明每一输出数据的格式，如：首部、主体和尾

15、部的具体形式。】4.3.3举例4.4出错和恢复【给出：出错信息及其含意；用户应采取的措施，如修改、恢复、再启动。】4.5求助查询【说明如何操作。】5.运行说明5.1运行表【列出每种可能的运行情况，说明其运行目的。】5.2运行步骤【按顺序说明每种运行的步骤，应包括：】5.2.1运行控制5.2.2操作信息运行目的；操作要求；启动方法；预计运行时间；操作命令格式及说明；其他事项。5.2.3输入/输出文件【给出建立或更新文件的有关信息，如：】文件的名称及编号；记录媒体；存留的目录；文件的支配【说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等。】5.2.4启动或恢复过程6.非常规过程【提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。】7.操作命令一览表【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。】8.程序文件（或命令文件）和数据文件一览表【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。】9.用户操作举例