可行性研究报告 项目开发计划 需求规格说明书 概要设计说明

231 GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。

这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。

一、可行性研究报告l 引言1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。

1.2 背景 说明：a ．所建议开发的软件系统的名称。

b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。

c ．该软件系统同其他系统或其他机构的基本的相互来往关系。

1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4 参考资料列出用得着的参考资料，如：a ．本项目的经核准的计划任务书或合同、上级机关的批文。

b ．属干本项目的其他已发表的文件。

c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。

2.1 要求说明对所建议开发软件的基本要求，如： a ．功能。

b ．性能。

c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。

d. 输入说明。

系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。

e ．处理流程和数据流程。

用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。

f. 在安全与保密方面的要求。

g. 同本系统相连接的其他系统。

h. 完成期限。

2.2 目标说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。

b. 处理速度的提高。

c. 控制精度或生产能力的提高。

232 d ．管理信息服务的改进。

《需求规格说明书》编写参考指南1．概述（Summary）本文档是进行项目策划、概要设计和详细设计的基础，也是软件企业测试部门进行内部验收测试的依据。

1.1 用户简介（User Synopsis）在本章节中要将用户的基本情况描述清楚，以便于分析人员划定系统范围，进行功能、进度、成本、性能等方面的平衡决策。

对于产品开发类项目，需要在此将该产品定义的用户群的特点描述清楚。

1.2 项目的目的与目标（Purpose and Aim of Project）项目的目的是对开发本系统的意图的总概括。

项目的目标是将目的细化后的具体描述。

项目目标应是明确的、可度量的、可以达到的, 项目的范围应能确保项目的目标可以达到。

对于项目的目标可以逐步细化，以便与系统的需求建立对应关系，检查系统的功能是否覆盖了系统的目标。

1.3 术语定义（Terms Glossary）将该需求规格说明书中的术语、缩写进行定义, 包括用户应用领域与计算机领域的术语与缩写等。

1.4 参考资料（References）说明该用户需求报告使用的参考资料，如：[1] 商务合同[2] 招标书[3] 用户领域的资料[4] 用户需求调查表[5] 用户需求报告[6] 参照的标准每一个文件、文献要有标题、或文件号，发布或发表日期以及出版单位。

1.5 相关文档（Related Documents）[1] 项目开发计划[2] 概要设计说明书[3] 详细设计说明书1.6 版本更新信息（V ersion Updated Record）版本更新记录格式，如表5-19所示。

表5-19 版本更新记录2．目标系统描述（System in Target）2.1 组织结构与职责（Organizing Framework and Function）将目标系统的组织结构逐层详细描述，建议采用树状的组织结构图进行表达，每个部门的职责也应进行简单的描述。

组织结构是用户企业业务流程与信息的载体，对分析人员理解企业的业务、确定系统范围很有帮助。

附2:软件文档编写向导文档分类项目包括如下几类文档：项目管理文档。

包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》软件开发文档。

包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。

产品文档。

包括：《用户操作手册》《演示文件》。

软件项目计划（Software Project Plan）一．引言1．编写目的（阐明编写软件计划的目的，指出读者对象。

）2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。

）3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。

）4．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。

）二．项目概述1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。

)2. 条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。

）3. 产品（1）程序（列出应交付的程序名称使用的语言及存储形式。

）（2）文档（列出应交付的文档。

）（3）运行环境（应包括硬件环境软件环境。

）4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。

）5．验收标准三．实施计划1．任务分解（任务的划分及各项任务的负责人。

）2．进度（按阶段完成的项目,用图表说明开始时间完成时间。

）3．预算4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。

）四．人员组织及分工五．交付期限六．专题计划要点（如测试计划等。

）项目开发进度报告一．报告时间及所处的开发阶段二．给出进度1．本周的主要活动2．实际进展与计划比较三．所用工时（按不同层次人员分别计时。

）四．所有机时五．工作遇到的问题及采取的对策六．本周完成的成果七．下周的工作计划八．特殊问题项目开发总结报告一．引言1．编写目的（阐明编写总结报告的目的,指明读者对象。

二、项目开发计划1．引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (2)1.4参考资料 (2)2．项目概述 (2)2.1工作内容 (2)2.2条件与限制 (3)2.3产品 (5)2.4运行环境 (6)2.5服务 (6)2.6验收标准 (7)3．实施计划 (7)3.1任务分解 (7)3.2进度 (7)3.3预算 (9)3.4关键问题 (10)4．人员组织及分工 (10)5．交付期限 (11)6．专题计划要点 (11)6.1测试计划 (11)6.2质量保证计划 (12)6.3配置计划 (12)6.4人员培训 (13)6.5系统安装 (13)1．引言1.1编写目的为了保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，使项目工作开展的各个过程合理有序，有必要以文件化的形式，把对于在项目生命周期内的工作任务范围、各项工作的任务分解、项目团队组织结构、各团队成员的工作责任、团队内外沟通协作方式、开发进度、经费预算、项目内外环境条件、风险对策等内容以书面的方式描述出来，作为项目团队成员以及项目干系人之间的共识与约定，项目生命周期内的所有项目活动的行动基础，项目团队开展和检查项目工作的依据。

1.2项目背景在日常生活中，在既是个人场所又是公共场所的地方。

例如：宿舍、公司等。

当我们外出时，可能会出现私人物品被盗或丢失的情况，此时保安人员也无法分辨物品是否属于携带者。

这时就需要一种设备来保护财务的安全。

根据这一需求，本文提出了一种简化式的防盗报警系统。

目前市场上的防盗报警系统装置为较常见的红外报警器，适用于没人的环境，不适用于多人居住的集体宿舍。

还有一些磁敏报警器，它们虽然可以用于门窗，但是每次使用都要人为地打开或关闭，不能够实现自动化，一旦忘记打开就形同虚设，如果素色无人的情况下即使报警也很容易被破坏，无法起到报警的作用。

因此，设计一款安全可靠的防盗报警系统变得十分有必要。

实用文档【软件名称】版本号：V1.0用户手册2022年3月9日目录目录第一章引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (1)1.4参考资料 (1)第二章软件概述 (1)2.1目标 (1)2.2功能 (1)2.3性能 (2)第三章运行环境 (2)3.1硬件 (2)3.2支持软件 (2)第四章使用说明 (2)4.1安装和初始化 (2)4.1.1 软件安装 (3)4.2软件使用 (3)4.3出错和恢复 (3)4.4求助查询 (3)第五章运行说明 (4)5.1运行表 (4)1第一章引言1.1编写目的1.2项目背景开发软件的名称：开发软件版本号：V1.0开发者：代码行数：行软件开发语言：软件编译环境:1.3定义1.4参考资料1．可行性研究报告2．项目开发计划；3．需求规格说明书；4．概要设计说明书；5．详细设计说明书；6．测试计划；7．《计算机软件文档编制规范GB/T8567-----2006》第二章软件概述2.1目标2.2功能图表 1 软件设计构成11、防伪码模块功能：查询防伪码的信息2、添加防伪码模块功能：添加新的防伪码3、添加管理员模块：功能：添加新的后台管理员2.3性能第三章运行环境3.1硬件（1）软件开发环境CPU:Intel(R)Core(TM)*******************内存:16 GB磁盘:NVMe SanDisk Ultra 3D 1TB显卡:NVIDIA NVIDIA GeForce RTX 2060（2）软件支持环境CPU:Intel(R) Core(TM) i5-2400以上内存：2GB以上磁盘：128M可用空间以上显卡：Intel HD3000 核心显卡以上运行环境：Tomcat 9.0.313.2支持软件操作系统： Windows7及以上更高64位版本第四章使用说明4.1安装和初始化该系统需要安装TomCat 9.0.31环境、Mysql 5.5.62。

HHHH大学航空订票系统（Airline Reservation System）姓名：AAA（项目经理）BBB、CCC、DDDEEE、FFF专业：软件工程指导老师：GGG目录一、可行性研究报告1、报告编写目的2、项目概述--------------------------------------------------------（主要负责人：EEE）2.1、项目背景2.2、项目意义2.3、项目目标2.4、项目用途3、技术可行性-----------------------------------（主要负责人：FFF）3.1、可行性因素3.2、技术条件3.3、用户使用可行性3.4、系统可行性简要描述3.5、系统可行性处理流程二、项目开发计划----------------------------------（主要负责人：AAA）1、工作内容2、主要参与人员3、产品3.1、软件包3.2、设计文档3.3、软件操作手册3.4、服务4、完成项目的期限5、项目的计划进度表6、实施计划6.1、工作任务的分解与人员的分工三、需求规格说明书--------------------------------（主要负责人：AAA）1、用户需求2、功能性需求2.1、运行环境2.2、系统层次结构图2.2.1、航空机票预订网站2.2.2、航空订票管理系统3、非功能性需求3.1、性能需求3.2、安全性需求3.3、可靠性和可用性需求3.4、出错处理需求3.5、接口需求3.6、约束3.7、逆向需求3.8、将来可能提出的要求4、其他需求四、概要设计说明书--------------------------------（负责人：所有人）1、总体设计1.1、总体结构设计1.2、运行环境设计1.3、功能模块清单设计2、模块（部件）清单设计2.1、公用模块功能分配2.2、专用模块功能分配3、数据结构设计3.1、数据库表名清单3.2、数据库表之间关系说明3.3、数据库表的详细清单4、接口设计五、详细设计说明书--------------------------------（负责人：所有人）1、模块实现设计1.1、公用模块设计1.2、专用模块设计2、接口实现设计六、数据库设计说明书------------------------------（主要负责人：AAA）1、数据库结构设计2、数据库的安全保密性设计3、数据库优化4、数据库源代码七、测试计划--------------------------------------（负责人：所有人）1、单元测试2、功能测试八、测试分析报告----------------------------------（主要负责人：AAA）1、测试计划执行情况2、软件需求测试结论九、项目开发总结报告------------------------------（负责人：所有人）AAABBBCCCDDDEEEFFF十、系统源程序------------------------------------（负责人：所有人）十一、操作手册------------------------------------（负责人：所有人）一、可行性研究报告1、报告编写目的可行性研究的目的是为了对问题进行研究，以最小的代价在最短的时间内确定问题是否可解。

在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。

一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。

1、软件需求说明书：也称为软件规格说明。

该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。

它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。

其格式要求如下：1 引言1．1 编写目的。

1．2 背景1．3 定义2 任务概述2．2 用户的特点2．3 假定和约束3 需求规定3．1 对功能的规定3．2 对性能的规定3．2．1 精度3．2．2 时间特性的需求3．2．3 灵活性3．3 输入输出要求3．4 数据管理能力要求3．5 故障处理要求3．6 其他专门要求4 运行环境规定4．1 设备4．2 支持软件4．3 接口2、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。

编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。

流程、程序系统的组织结构、模块划分、功能分配、接口设计。

运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。

其格式要求如下：1 引言1．1 编写目的1．2 背景1．3 定义1．4 参考资料2 总体设计2．1 需求规定2．2 运行环境2．3 基本设计概念和处理流程2．4 结构2．5 功能需求与程序的关系2．6 人工处理过程2．7 尚未解决的问题3 接口设计3．1 用户接口3．2 外部接口3.。

3 内部接口4 运行设计4．1 运行模块的组合4．2 运行控制4．3 运行时间5 系统数据结构设计5．1 逻辑结构设计要点5．2 物理结构设计要求5．3 数据结构与程序的关系6 系统出错处理设计6．1 出错信息6．2 补救措施6．3 系统维护设计。

软件设计文档国家标准GB8567-88一、文档编写标准化在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

10、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

软件设计文档国家标准GB8567-88一、文档编写标准化在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

10、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。

它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。

该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。

下面详细介绍这14种文件的编写目的与内容要求。

l、可行性研究报告可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。

可行性研究报告的编写内容见表l。

表l 可行性研究报告2、项目开发计划编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。

编制内容要求如表2所示。

表2 项目开发计划3、软件需求说明书软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解，使之成为整个软件开发工作的基础。

其内容要求见表3。

表3 软件需求说明书4、数据要求说明书数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。

表4 数据要求说明书5、概要设计说明书概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。

其内容要求见表5。

表5 概要设计说明书6、详细设计说明书详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。

可行性研究报告项目开发计划需求规格说明书概要设计说明一、引言在本文档中，将详细说明可行性研究报告项目开发计划的需求规格和概要设计。

本文档的目标是为项目团队提供一个清晰的指导，以确保项目的顺利进行。

二、项目概述可行性研究报告项目是一个用于评估一项新业务或投资项目的潜在可行性的工具。

该系统将提供一个网页界面，用户可以通过输入相关信息来评估项目的可行性。

系统还将提供一个报告生成功能，以便用户可以生成详细的可行性报告。

三、需求规格说明书1.功能性需求a.用户登录：用户可以通过输入用户名和密码登录系统。

b.项目信息录入：用户可以录入新的项目信息，包括项目名称、项目描述、项目预算等。

c.数据录入：用户可以录入与项目相关的数据，如销售数据、成本数据等。

d.可行性计算：系统将根据录入的数据和项目信息进行可行性计算，并显示计算结果。

e.报告生成：用户可以生成可行性报告，报告应包括项目信息、可行性计算结果和详细说明。

2.可靠性需求a.数据备份：系统应具备自动数据备份功能，以避免数据丢失。

b.数据安全性：系统应采用适当的安全措施，保护用户数据的安全性和隐私。

3.可用性需求a.用户界面友好：系统应提供简洁、直观的用户界面，以便用户轻松使用。

b.错误处理：系统应能够处理用户输入错误或异常情况，给予相应的提示和建议。

4.可维护性需求a.代码模块化：系统应采用合理的模块化设计，以便快速修复和扩展系统功能。

b.代码注释：系统代码应包含详细的注释，以方便代码维护和修改。

5.性能需求a.响应时间：系统应在合理的时间范围内响应用户的操作请求，以提供良好的用户体验。

b.扩展性：系统应具备良好的扩展性，以应对日益增长的用户和数据量。

1.系统架构a. 前端设计：系统前端将使用HTML、CSS和JavaScript来实现用户界面。

b. 后端设计：系统后端将使用Java开发，采用MVC架构模式来实现业务逻辑和数据处理。

2.数据库设计a.数据库类型：系统将使用关系型数据库存储用户和项目数据。

软件设计文档国家标准GB８５６７-88一、文档编写标准化在整个项目开发及使用过程中,应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书(软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

７、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况,对测试结果的分析,提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

１0、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

附2:软件文档编写向导文档分类项目包括如下几类文档：项目管理文档。

包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》软件开发文档。

包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。

产品文档。

包括：《用户操作手册》《演示文件》。

软件项目计划〔Software Project Plan〕一．引言1．编写目的〔说明编写软件计划的目的，指出读者对象。

〕2．项目背景〔可包括：〔1〕项目委托单位、开发单位和主管部门；〔2〕该软件系统与其他系统的关系。

〕3．定义〔列出本文档中用到的专门术语的定义和缩略词的原文。

〕4．参考资料〔可包括：文档所引用的资料、规X等；列出资料的作者、标题、编号、发表日期、单位或资料来源。

〕二．项目概述1. 工作内容〔简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 假如不编写可行性研究报告,如此应在本节给出较详细的介绍。

)2. 条件与限制〔说明为完成项目应具备的条件开发单位已具备的条件以与尚需创造的条件. 必要时还应说明用户与分合同承包者承当的工作完成期限与其它条件与限制。

〕3. 产品〔1〕程序〔列出应交付的程序名称使用的语言与存储形式。

〕〔2〕文档〔列出应交付的文档。

〕〔3〕运行环境〔应包括硬件环境软件环境。

〕4．服务〔说明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。

〕5．验收标准三．实施计划1．任务分解〔任务的划分与各项任务的负责人。

〕2．进度〔按阶段完成的项目,用图表说明开始时间完成时间。

〕3．预算4．关键问题〔说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。

〕四．人员组织与分工五．交付期限六．专题计划要点〔如测试计划等。

〕项目开发进度报告一．报告时间与所处的开发阶段二．给出进度1．本周的主要活动2．实际进展与计划比拟三．所用工时〔按不同层次人员分别计时。

〕四．所有机时五．工作遇到的问题与采取的对策六．本周完成的成果七．下周的工作计划八．特殊问题项目开发总结报告一．引言1．编写目的〔说明编写总结报告的目的,指明读者对象。

软件可行性研究报告模板篇一：软件工程_可行性研究报告模板(国家标准)可行性研究报告(ISO标准)编者说明：在立项时，应该对项目进行综合分析，探讨项目的经济、社会、技术可行性，从而为决策提供基础。

该模板为ISO 标准文档模板，其不仅适用于软件项目，对于其它的系统项目也适用。

1. 引言编写目的[编写本可行性研究报告的目的，指出预期的读者。

]背景a.[所建议开发的软件系统的名称；]b.[本项目的任务提出者、开发者、用户及实现该软件的计算站或计算机网络；]c.[该软件系统同其他系统或其他机构的基本的相互来往关系。

]定义[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

]参考资料[列出用得着的参考资料。

]2. 可行性研究的前提[说明对所建议开发的软件的项目进行可行性研究的前提。

]要求[说明对所建议开发的软件的基本要求。

]目标[说明所建议系统的主要开发目标。

]条件、假定和限制[说明对这项开发中给出的条件、假定和所受到期的限制。

]进行可行性研究的方法[说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的，摘要说明所使用的基本方法和策略。

] 评价尺度[说明对系统进行评价时所使用的主要尺度。

]3. 对现有系统的分析[这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。

][分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。

]处理流程和数据流程[说明现有系统的基本的处理流程和数据流程。

此流程可用图表即流程图的形式表示，并加以叙述。

]工作负荷[列出现有系统所承担的工作及工作量。

]费用开支[列出由于运行现有系统所引起的费用开支。

]人员[列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。

]设备[列出现有系统所使用的各种设备。

]局限性[列出本系统的主要局限性。

]4. 所建议的系统对所建议系统的说明[概括地说明所建议系统，并说明在第2条中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。

目录1. 前言11.1 目的11.2 术语11.3 参考文献11.4 版本说明和修改历史12. 软件文档12.1 文档的定义及作用12.2 软件文档的分类22.3 软件文档的制作与软件生存周期之间的关系3 2.4 文档的使用者33. 文档编制格式规范43.1 文档编码规则43.2 文档组成格式43.2.1 封面43.2.2 目录63.2.3 版本更新说明63.2.4 文件内容63.2.5 正文格式63.3 文档制作工具74. 文档管理规范74.1 文档管理岗位职责74.2 文档的制作74.2.1 文档的分类、编码与标识84.2.2 文档的作者、修改者和打字者84.3 文档的收集84.4 文档的配置84.5 文档的控制84.6 文档的修改管理94.7 文档的借阅和复制管理制度94.8 文档的保密性95. 技术文档的质量评价101.前言1.1 目的软件开发的不同阶段都会产生大量的文档。

为了加强管理、提高工作效率，充分借鉴前人的经验，对文档进行规范化管理是很有必要的。

它对于保管在开发中形成的文档，为公司积累宝贵的技术知识的财富，为今后的软件开发工作提供第一手的宝贵资料起着重要的作用。

为了规范创智集团工程项目的开发工作，根据国家标准局制定的有关软件开发和开发文件的规范标准，结合公司的实际，制定本规范。

1.2 术语略。

1.3 参考文献1)《1998计算机软件工程规范----国家标准》中国标准出版社1998年6月第一版。

2)《软件工程概论》郑人杰等清华大学出版社1998年4月第一版。

3)《实用软件工程》郑人杰等清华大学出版社1997年4月第二版。

4)《创智软件园文档管理规范》创智（湖南）软件园有限公司1996年5月。

5)《创智软件园软件开发管理规范》创智（湖南）软件园有限公司1995年12月。

1.4 版本说明和修改历史本规范是在公司原有文档规范的基础上，于1999年05月份修订而成，具体的修订人员为孙继纲、赵海等。

软件需求，概要设计，详细设计（⽂档）软件需求，概要设计，详细设计（⽂档）怎么做，做什么？52018.06.15 08:09:26字数 2451阅读 36159写在前⾯由于项⽬⼯作需要，需要提供《软件需求规格说明书》，《软件概要设计说明书》和《软件详细设计说明书》。

所以这⾥整理学习⼀下相关⽂档需要的内容。

⽂章并不设计对所有需求分析，概要设计和详细设计的详细描述。

因为这其中的任何⼀点都可以单独提取出来成为软件⼯程学科中的⼀本书籍内容。

1 软件设计的整体流程：软件需求分析阶段：输出了《软件需求规格说明书》，不涉及具体实现⽅法。

⽤户能看得明⽩，开发⼈员也可据此进⾏下⾯的⼯作，搞清楚“要解决什么问题”。

概要设计阶段：确定软件系统的总体布局，各个⼦模块的功能和模块间的关系，与外部系统的关系，选择的技术路线。

有⼀些研究与论证性的内容。

并输出《软件概要设计说明书》。

搞清楚“总体实现⽅案”详细设计阶段：对概要设计的进⼀步细化，⼀般由各部分的担当⼈员依据概要设计分别完成，然后在集成，是具体的实现细节。

是“程序”的蓝图，确定每个模块采⽤的算法、数据结构、接⼝的实现、属性、参数。

并输出《软件详细设计说明书》。

搞清楚“每个模块怎么做”2 需求分析2.1 我们为什么需要《软件需求规格说明书》？如果需求的编写只是为了解释说明软件实现的功能，那么良好的编码结构，代码注释就可以很好的实现软件的功能说明，程序员可以将编写需求的时间节约下来进⾏更多功能的实现；可是，这样的情况可能更多适⽤于中⼩型项⽬，或者互联⽹项⽬，因为这样的项⽬需求不复杂，并且需求变化很快，所以研发的效率⾮常重要。

然⽽，针对⼤型软件项⽬或者功能⽐较复杂的系统，软件研发可能是多⼈协作的成果，所以在信息传递过程中，我们只有提前考虑好软件需求的内容，才能正确评估开发软件所需要的时间，成本的要素，从⽽更好的管理项⽬。

2.2 《软件需求规格说明书》的⼀般结构正⽂的第⼀章内容是1.概述，包含1.1.编写⽬的；1.2.术语与定义；1.3.参考资料；三个部分第⼆章要给出该项⽬的标准和规范，在⽂档的后续内容编写中以及项⽬开发过程中必须遵照这个标准和规范进⾏。

软件工程之分析设计课程设计报告学院：计算机科学与技术学院专业：软件工程班级：0602班学号：06001647姓名：马超（组长）同组人：路凯王志刚赵鑫指导教师：李爱萍宋春花时间：2009年6月校内资源共享系统项目分工1、概要分工：2、详细分工：由于我们软件开发小组人员有限，并且时间有限，我们不可能让需求分析员，做完需求分析，就闲着；也不可能让测试师、编程人员在可行性研究阶段闲着。

所以，我们在做每个阶段时，都是有明确分工的。

让每个成员都参与，发挥各自的聪明才智，提出各自的主张，并进行激烈的探讨。

在这种氛围下，我们提出了我们的产品目的，明确了产品的功能，完善了产品各方面的性能，并将各个模块的核心代码基本都落实，并最终结束了各方面的测试，完成了本系统的设计。

校内资源共享系统可行性分析报告1 引言1．1编写目的：可行性研究的目的是为了对问题进行研究，以最小的代价在最短的时间内确定问题是否可解。

经过对此项目进行详细调查研究，初拟系统实现报告，对软件开发中将要面临的问题及其解决方案进行初步设计及合理安排。

明确开发风险及其所带来的经济效益。

本报告经审核后，交软件经理审查及软件开发人员分析。

1.2 项目背景：开发软件名称：校内资源共享系统。

项目任务提出者：项目组成员。

项目开发者：王志刚路凯赵鑫马超。

用户：学校全体师生。

实现软件单位：太原理工大学网络中心项目与其他软件，office 播放器下载工具（如迅雷）：本项目采用B/S架构，客户端的程序是建立在Windows xp 系统上。

以J2EE ORACLE为应用程序的开发软件，服务器端采用Windows工作站，是采用Oracle 10g的为开发软件的数据库服务程序。

1．3 定义：[专门术语]：Oracle10g: 系统服务器所使用的数据库管理系统（DBMS）。

SQL: 一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。

主键：数据库表中的关键域。