模块开发卷宗编写规范

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章模块开发情况 (1)
第2章功能说明 (1)
第3章设计说明 (1)
3.1 层次说明 (1)
3.2 算法（Ｎ－Ｓ图、ＰＡＤ图或ＰＤＬ语言） (2)
3.3 外部数据结构 (2)
3.4 出错信息 (2)
第4章源代码清单 (2)
第5章测试说明 (2)
5.1 测试名称1 (2)
5.2 测试名称2 (2)
第6章复审结论 (3)
6.1 与需求说明的比较 (3)
6.2 与概要设计的比较 (3)
6.3 与详细设计的比较 (3)
6.4 一般结论 (3)
第1章模块开发情况
第2章功能说明
第3章设计说明
3.1层次说明
1
3.2算法（Ｎ－Ｓ图、ＰＡＤ图或ＰＤＬ语言）3.3外部数据结构
3.4出错信息
第4章源代码清单
第5章测试说明
5.1测试名称1
测试标识符：编号：
测试目的：
测试配置：
5.2测试名称2
…………
2
第6章复审结论
6.1与需求说明的比较
6.2与概要设计的比较
6.3与详细设计的比较
6.4一般结论
3。

模块开发卷宗1标题软件系统名称：酒店管理系统模块名称用户输入模块用户输出模块小组人员邓炜、赵佳、李春锦、王萱、李苗、赵伟修改完成日期 2021-11-21 编排日期（2021-11-21）2模块开发情况表系统总体结构主模块 Main 用户输入模块 User input 输出模块 Output 系统管理模块 System management 用户输入处理模块 User use 输出处理模块 Display 住宿管理员用户模块Zhusu management 数据信息管理员用户模块 Data management 账号信息管理员用户模块Id management 正常显示模块 Right display 出错显示模块 Error display 住宿管理模块 Zhusu informatio数据信息管理员管理模块 Data 账号信息管理模块 Id informatio 房间信息管理模块 Manager Fangjian顾客住宿记录信息管理模块 Manager 模块子系统结构(用户输入模块)输入用户名输入输入密码用户名判断处理密码判断权限判断输出用户名错误密码错误正确登录该模块是用户登录时所必须要用到的，登陆之前需要验证用户身份的合法性，故而需要用户输入程序，输入用户名及密码来进行身份验证。

模块子系统结构(用户输出模块)3功能说明 3.1 程序描述该程序是用户登录时所必须要用到的，登陆之前需要验证用户身份的合法性，故而需要用户输入程序，输入用户名及密码来进行身份验证。

本程序为非常驻内存，是子程序、可重用、是顺序处理，在输入之后方能进行验证3.2 功能输入用户名输入输入密码用户名判断处理密码判断权限判断输出用户名错误密码错误正确登录3.3 性能精度要求精确到整型的个位、字符型完全正确，不支持部分匹配；时间特性要求：要求等待时间＜０．５ｓ3.4 输入项输入项名称：用户名类型：字符串型输入方式：手工输入数据来源：系统自带的数据库中的信息输入项名称：密码类型：字符串型输入方式：手工输入数据来源：系统的数据库中的信息安全保密条件：在输入密码时用户界面上显示为＊＊＊＊＊＊3.5 输出项输出项：用户名错误输出数据类型：字符串型输出以信息对话框的形式输出输出内容是用户名错误，请重新输入输出项：密码错误输出数据类型：字符串型输出信息也是以信息对话框的形式输出输出内容是密码错误，请重新输入输出项：正确登陆数据类型：字符串型输出内容是根据用户权限而得到的用户界面的输出3.6 算法本程序需要对数据库进行操作，即对数据库进行查询 Select 用户名 From USER_PSDWhere 用户名=输入内容如果结果为空，则输出：用户名错误，请重新输入；三次输入错误则关闭系统Select 密码Form USER_PSDWhere 用户名=输入内容 and 密码=输入内容如果结果为空，则输出：用户密码错误，请重新输入；三次输入错误则关闭系统查询到一条记录后，进行权限判断，以决定让该用户使用相应的功能。

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（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 范围本指南是一份指导性文件。

本指甫建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。

这十四种文件是：可行性研究报告；项目开发计划；软件需求说明书；数据要求说明书；概要设计说明书；详细设计说明书；数据库设计说明书；用户手册；操作手册；模块开发卷宗；测试计划；测试分析报告；开发进度月报；项目开发总结报告。

本指南将给出开发过程中建议产生的这十四种文件的编制指导，同时，本指南也是这十四种文件的编写质量的检验准则。

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

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

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

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

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

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

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

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

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

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

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

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

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

b ．性能。

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

d. 输入说明。

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

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

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

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

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

h. 完成期限。

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

b. 处理速度的提高。

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. 控制精度或生产能力的提高。

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

e. 自动决策系统的改进。

f. 人员利用率的改进。

2.3 条件、假定和限制说明对这项开发中给出的条件、假定和所受到的限制，如a. 所建议系统的运行寿命的最小值。

软件模块开发卷宗1. 概述在软件开发过程中，模块开发是一个重要的环节。

软件模块是指在软件系统中具有独立功能或特性的部分，通常由一组功能相对独立且彼此之间有关联的代码块组成。

本文档将介绍软件模块开发的流程、方法和注意事项。

2. 模块开发流程2.1 需求分析在进行模块开发之前，首先需要进行需求分析。

需要明确模块的功能、接口、输入输出等方面的需求，以确保开发的模块符合用户的需求。

2.2 设计在需求分析的基础上，进行模块的设计。

设计包括模块的接口设计、算法设计、数据结构设计等方面，以确保模块的可扩展性和可维护性。

2.3 编码根据设计文档，进行模块的编码工作。

在编码过程中，需要遵循团队的编码规范，编写清晰、易读、可维护的代码。

2.4 测试完成编码后，需要对模块进行测试。

测试包括单元测试、集成测试、系统测试等，以确保模块的功能正确、性能良好。

2.5 集成完成测试后，将模块集成到系统中进行整体测试。

在集成过程中可能会出现一些问题，需要及时解决。

3. 模块开发方法3.1 模块化设计模块化设计是将功能相关的代码模块集成在一起，使得代码结构清晰、易于扩展和维护。

采用模块化设计可以提高代码的复用性和可读性。

3.2 组件化开发组件化开发是将通用的功能封装成组件，以便在不同的模块中重复使用。

通过组件化开发可以减少开发工作量，提高开发效率。

3.3 接口设计模块之间通过接口进行通信。

良好的接口设计可以提高模块之间的耦合度，降低修改一个模块对其他模块的影响。

4. 模块开发注意事项4.1 遵循团队规范在模块开发过程中，需要遵循团队的编码规范、命名规范、文档规范等，以确保代码的质量和一致性。

4.2 注释在编写代码时，需要添加适当的注释。

注释可以帮助他人理解代码的意图和实现方式，提高代码的可读性。

4.3 异常处理在模块开发中，需要注意异常处理。

对可能出现异常的地方进行有效的异常处理，以保证系统的稳定性和可靠性。

5. 总结软件模块开发是软件开发过程中至关重要的一环。

标准的软件开发过程需要编写的文档软件开发的标准过程包括六个阶段，而六个阶段需要编写的各类文件达14种之多，在每个阶段需要编写哪些文件，以及这些文件的主要内容见下：1。

可行性与计划研究阶段（1）可行性研究报告：在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。

（2）项目开发计划：编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来,以便根据本计划开展和检查本项目的开发工作。

2。

需求分析阶段（1)软件需求说明书:软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。

内容包括对功能的规定对性能的规定等.（2）数据要求说明书：数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。

（3）初步的用户手册:用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。

使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。

3.设计阶段（1)概要设计说明书：概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统.编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。

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

（2）详细设计说明书:详细设计说明书又可称程序设计说明书.编制目的是说明一个软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑，如果一个软件系统比较简单，层次很少,本文件可以不单独编写,有关内容合并入概要设计说明书。

（3）数据库设计说明书:数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。

模块开发卷宗（GB8567——88）1标题a.项目名称：企业管理平台b.企业人才管理系统分为两大模块：企业首页和企业后台c.项目参加人员：白璐、田放、刘保萍、贺晓利、翟金会，赵娜娜，张丽洁d.程序的修改完成日期为：2008年11月9日2模块开发情况表企业管理平台中的两大模块首页和后台如下：企业管理平台中的企业首页中的流程如下：企业管理平台的企业后台流程图入如下：3功能说明（1）企业首页模块中呈现的功能有企业首页、企业网站、企业内部网、企业招聘、企业多媒体教学、企业论坛等，企业的首页中有企业的产品图书可以供浏览者下载，可以使用产品下载，客户的反馈信息，添加留言；（2）企业内部网有用户的登录注册，员工的基本信息表；（3）企业招聘中有企业推荐信息，招聘信息、培训信息、公寓信息、家教信息、寻求合作等信息的浏览（4）企业多媒体教学中有发布教程、视频课堂、语音课堂、可查询最新的视频语音学习的相关知识，可提供浏览者下载视频等（5）企业论坛中可以发表自己的评语等(6) 企业管理平台的后台管理模块中有网站的管理、人才管理、招聘培训、媒体教程、系统管理（7）网站管理中有产品管理的搜索和添加产品，留言管理的添加、删除，修改留言等，上传管理的查看和添加企业的产品，产品类别管理的添加和删除等功能（8）人才管理中的公告管理，文件管理的接收、发送、删除文件等功能，投票管理中添加活动项目和活动投票数、考勤管理的上下班签到的制定、部门管理的添加和编辑部门、员工管理的删除和编辑员工的基本信息、规章制度中的基本信息管理等（9）企业招聘培训中的招聘管理可以查看、是否通过或者取消的功能，求职管理中的查询、求职的通过或取消等功能，家教管理的查看信息、是否通过或取消，公寓管理的信息查看、通过或取消信息，培训管理的信息查询、通过或者取消信息，寻求合作管理的查看信息、是否通过或者取消发布信息，发布信息管理中的管理员发布所需要的基本信息，编辑信息并发布在网站的首页（10）企业媒体教程的语音管理和视频管理，语音管理中的查询管理的基本信息和是否删除和查看语音留言管理等功能，在视频管理中可以查看视频的基本信息和是否删除视频教程，查看视频留言的管理等信息（11）企业系统管理中的添加用户，修改密码，数据备份，数据初始化，恢复数据，会员管理。