10模块开发卷宗编写模板
标准的软件开发过程需要编写的文档
标准的软件开发过程需要编写的文档软件开发的标准过程包括六个阶段，而六个阶段需要编写的各类文件达 每个阶段需要编写哪些文件，以及这些文件的主要内容见下：1. 可行性与计划研究阶段1）可行性研究报告：在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。
2）项目开发计划：编制项目开发计划的目的是用文件的形式，把对于在开发过程中来，以便根据本计划开展和检查本项目的开发工作。
2. 需求分析阶段1）软件需求说明书：软件需求说明书的编制是为了使用户和软件开发者双方对该软性能的规定等。
2）数据要求说明书：数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。
3）初步的用户手册：用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。
使用户 （或潜在用户） 通过本手册能够了解该软件 的用途，并且能够确定在什么情况下，如何使用它。
3. 设计阶段1）概要设计说明书：概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。
编制的目的是说明对程序系统的设计考虑， 包括程序系统的基本处理流程、 程序14 种之多，在各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载件的初始规定有一个共同的理解， 使之成为整个开发工作的基础。
内容包括对功能的规定对系统的组织结构、模块划分、功能分配、接口设计。
运行设计、数据结构设计和出错处理设 计等，为程序的详细设计提供基础。
2）详细设计说明书：详细设计说明书又可称程序设计说明书。
编制目的是说明一个 软件系统各个层次中的每一个程序 （每个模块或子程序） 的设计考虑， 如果一个软件系统比 较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。
3）数据库设计说明书：数据库设计说明书的编制目的是对于设计中的数据库的所有 标识、逻辑结构和物理结构作出具体的设计规定。
GB-T 8567-1988-10：模块开发卷宗
此处插入公司LOGO目录1.标题 (4)2.模块开发情况表 (4)3.功能说明 (4)4.设计说明 (5)5.原代码清单 (5)6.测试说明 (5)7.复审的结论 (5)使用说明：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。
编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。
（注意：蓝字部分在正式文档中删掉）1.标题提示：软件系统名称和标识符模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）程序编制员签名卷宗的修改文本序号修改完成日期卷宗序号（说明本卷宗在整个卷宗中的序号）编排日期（说明整个卷宗最近的一次编排日期）（此处填写正文，注意：蓝字部分在正式文档中删掉）2.模块开发情况表3.功能说明提示：扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。
可以从系统设计说明书中摘录。
同时列出在软件需求说明书中对这些功能的说明的章、条、款。
（此处填写正文，注意：蓝字部分在正式文档中删掉）4.设计说明提示：说明本模块（或本组模块）的设计考虑，包括：a．在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；b．在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；c．在编制目前已通过全部测试的源代码时实际使用的设计考虑。
（此处填写正文，注意：蓝字部分在正式文档中删掉）5.原代码清单提示：要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
（此处填写正文，注意：蓝字部分在正式文档中删掉）6.测试说明提示：说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
2012-2013第二学期软件工程实验指导书--完整版
辽宁工程技术大学应用与技术学院实验指导书实验科目：软件工程及测试系别：计算机系专业：计算机应用编写人：包剑时间： 2013年2月前言《软件工程及测试实验》是为应用技术学院计算机应用专业《软件工程及测试》课程配套设置的，是《软件工程及测试》课程讲授中一个重要的、不可或缺的环节。
其目的是使学生能够针对具体软件工程项目，全面掌握软件工程管理、需求分析、概要设计、详细设计、软件测试等阶段的方法和技术，通过实验使学生进一步理解和掌握软件开发模型、软件生命周期、软件过程等理论在软件项目开发过程中的意义和作用，培养学生按照软件工程的原理、方法、技术、标准和规范，进行软件开发的能力，培养学生的合作意识和团队精神，培养学生对技术文档的编写能力，使学生提高软件工程的综合能力，提高软件项目的管理能力。
按该课程的特点，实验内容包括软件开发的两大方法学的专题训练，即结构化（生命周期学）的方法学和面向对象的方法学，通过分析一个简单项目，要求学生利用结构化软件开发技术或面向对象的软件开发技术完成对该项目的开发。
因此设置的实验项目，从项目开发的准备工作，系统分析过程，系统设计过程，软件测试到系统实施，覆盖软件开发的整个过程，此外又引入我国国家《计算机开发规范》，以规范技术文档的书写标准，提高实验教学质量。
通过实验训练，达到如下目的：使学生进一步了解和掌握软件工程原理，提高对实际项目的分析和设计能力，通过实验课程，熟悉和基本掌握软件工程方法学、软件开发的过程，文档资料的编写格式及规范，全面领会和贯通所学习的理论知识，从而培养学生综合运用所学课程知识，分析解决问题的能力，培养学生理论联系实际作风，实事求是，严肃认真的科学态度和良好的工作作风，为今后工作打下基础。
概述一、实验目的《软件工程及测试》是一门实践性很强的课程，上机实验是其重要的环节，实验配合《软件工程及测试》课程的学习而制订的，其实验目的和任务是：通过实验，熟悉和基本掌握软件的工程设计方法、软件工程设计的表达形式、以及实现工程设计的辅助软件工程工具的使用。
软件工程跟计算模块开发卷宗
模块开发卷宗1标题软件系统名称：学生宿舍管理系统DMS(Dormitory Manegement System)模块名称和标识符：(1)登录模块：logmod(2)管理员用户模块：stainfocenmod包括个人信息子模块(stainfo)，修改密码子模块(stachpwd)，报修信息子模块(starep)，意见建议子模块(stasug)和学生信息管理子模块(maninfo)。
(3)学生用户模块：stuinfocenrmod包括个人信息子模块(stuinfo)，修改密码子模块(stuchpwd)，报修信息子模块(sturep)和意见建议子模块(stusug)。
程序编制员签名：李剑、杨民岱、娄小敏、田海燕、沈大正卷宗的修改文本序号：修改完成日期：2011-12-22卷宗序号：5编排日期：2011-12-232模块开发情况表3功能说明(1)登录模块(logmod)：实现用户登录，系统将提示用户输入的信息，包括用户名和密码。
(2)管理员用户模块(stainfocenmod)：用户以管理员身份登录后，将进入管理员用户模块，进入管理员界面后可以看到可查看的信息或所拥有的权限。
包括：首页、个人信息、修改密码、报修信息、意见建议和学生信息。
a．首页：可以在此看到待处理的事项。
b．个人信息：可以查看登录者的本人信息。
c．修改密码：对本用户的密码进行修改，系统将提示输入旧密码和新密码并进行确认和提交。
d．报修信息：可以查看由普通用户即住宿学生提交的宿舍设施的报修信息，并进行处理。
在处理完毕后确认已报修，学生用户在登录后可以在相关界面看到已经处理的提示。
e．意见建议：可以查看学生用户对宿舍管理提出的意见和建议，并进行回复，也可以对已经处理或是不合理建议进行删除。
回复后学生用户可以在登录后查看到回复信息。
f．学生信息：可以查看已经注册的全部学生的住宿信息。
并且可以添加新的学生用户，以及对已有学生用户进行编辑，删除操作。
软件开发软件产品开发文件编制指南
附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。
它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。
该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。
下面详细介绍这14种文件的编写目的与内容要求。
l、可行性研究报告可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。
可行性研究报告的编写内容见表l。
表l 可行性研究报告2、项目开发计划编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。
编制内容要求如表2所示。
表 2 项目开发计划3、软件需求说明书软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解，使之成为整个软件开发工作的基础。
其内容要求见表3。
表3 软件需求说明书4、数据要求说明书数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。
表4 数据要求说明书5、概要设计说明书概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。
其内容要求见表5。
表5 概要设计说明书6、详细设计说明书详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。
卷宗侧面和卷内目录编写说明
卷宗侧面和卷内目录编写说明一、卷宗侧面编写说明1、流水号编写流水号———包含代码、指标序号、序列号代码———各部门名称大写拼音字母前两位指标序号———该支撑材料相对应的指标序号（为三位数）序列号———该盒材料在本部门所有材料中统一编号的具体位置（三位阿拉伯数字，各部门自编；黑体小初，居中排列，打印粘贴贴满）例如：第54条指标在服美系装袋的材料中，流水号表示为：FM054XXX 第54条指标在纺织系装袋的材料中，流水号表示为：FZ054XXX2、卷宗侧面的编号及卷内目录的编号的编写编号———一级指标、二级指标、主要观测点、与主要观测点相对应支撑材料出现的先后次序（注：卷宗侧面的编号及卷内目录的编号为同一编号）。
例如：指标体系中第38条指标“师资队伍建设/结构/专任教师结构/在职攻读硕士教师一览表”将表示为:2.1.2.33、案卷题名的编写案卷题名——相对应主要观测点名称和支撑材料的名称主要观测点名称横向排列（2号黑体，保留3行内容空间打印粘贴贴满）支撑材料名称中加粗的文字编排在主要观测点名称下纵向排列（小2号黑体字由左向右纵向居中排列，打印粘贴贴满）4、卷宗号的编写卷宗号———由指标序号（3位数）、该指标共有卷宗总量数、该卷宗在该指标卷宗总量中的位置组成例：服美系第54条指标共装有10袋材料，其中第二袋材料的卷宗号应为：卷054（2/10）二、卷内目录编写说明1、编号的编写与卷宗侧面编号格式相同（“编号”二字宋体16号，内容宋体14号）2、流水号编写与卷宗侧面编号格式相同（“流水号”三字宋体16号，内容14号）3、标题的编写标题———与该盒相对应评估指标体系中支撑材料名称中加粗的文字（“标题”二字宋体16号，内容14号）4、信息资料名称的编写信息资料名称———与支撑材料相对应的原始资料的名称5、资料序号的编写资料序号———该盒内装有的原始资料的先后顺序6、页码的编写页码———该信息资料在卷内所占的页码或页码区间（从头至尾统一编页，用铅笔标注在资料右下端中央）另：卷内目录用A4纸EXCEL表制作，并发送电子文档，卷内目录表格格式到评估办拷贝。
(完整版)软件开发文档模板
软件描述文档产品名称公司名称软件基本信息产品名称公司名称1、产品标识：×××软件标识：软件名称：×××软件型号及版本号：×××制造商：×××公司生产地址：×××2、安全性级别××是一种××软件，所以随之而来的软件安全性问题也极为重要。
(a)××软件是一种抽象的逻辑产品，其存在形式是虚拟和动态的……..(b)软件质量的测度十分困难，其质量的控制重点在软件的需求分析和设计阶段，开发过程中产生错误的难以追踪；……；(c)硬件有老化现象，失效曲线似浴盆，硬件的维护可通过纠错、修复或更换失效的系统重新恢复功能。
而软件的维护复杂，只有通过修改代码来排错。
同时软件可能在使用中随着缺陷的发现和消除，而使性能提高。
软件的修改看似比硬件容易，却比硬件更难于控制。
看上去无关紧要的软件代码修改会在软件的其他地方引起无法预测的、十分关键的问题；(d)软件的失效防护困难。
对硬件可采用预防性维护技术预防故障，采用断开失效部件的办法诊断故障，而软件则不能采用这些技术；但软件的失效会毫无征兆的出现，会因执行一条未经验证的路径而出现故障；而同一软件的冗余不能提高可靠性。
(e)软件的失效是系统性失效，其失效的条件有时比较复杂。
因此，可能会无法清晰地洞察其原因，而误归结其为系统中硬件的随机失效。
导致无法及时排除软件中的故障，造成隐患的长期存在。
以上论述了××软件的复杂性，以及出现问题无法预测性和软件的实效防护困难。
××软件一旦出现问题则很可能导致患者×××或者对患者造成严重的伤害，例如，×××软件一旦在运行过程中失效，机器停止工作则很可能导致患者由于××而变为×××，所以××软件安全性级别为××级。
模块开发卷宗
模块开发卷宗（GB8567——88）1标题a.项目名称：企业管理平台b.企业人才管理系统分为两大模块：企业首页和企业后台c.项目参加人员：白璐、田放、刘保萍、贺晓利、翟金会，赵娜娜，张丽洁d.程序的修改完成日期为：2008年11月9日2模块开发情况表企业管理平台中的两大模块首页和后台如下：企业管理平台中的企业首页中的流程如下：企业管理平台的企业后台流程图入如下：3功能说明（1）企业首页模块中呈现的功能有企业首页、企业网站、企业内部网、企业招聘、企业多媒体教学、企业论坛等，企业的首页中有企业的产品图书可以供浏览者下载，可以使用产品下载，客户的反馈信息，添加留言；（2）企业内部网有用户的登录注册，员工的基本信息表；（3）企业招聘中有企业推荐信息，招聘信息、培训信息、公寓信息、家教信息、寻求合作等信息的浏览（4）企业多媒体教学中有发布教程、视频课堂、语音课堂、可查询最新的视频语音学习的相关知识，可提供浏览者下载视频等（5）企业论坛中可以发表自己的评语等(6) 企业管理平台的后台管理模块中有网站的管理、人才管理、招聘培训、媒体教程、系统管理（7）网站管理中有产品管理的搜索和添加产品，留言管理的添加、删除，修改留言等，上传管理的查看和添加企业的产品，产品类别管理的添加和删除等功能（8）人才管理中的公告管理，文件管理的接收、发送、删除文件等功能，投票管理中添加活动项目和活动投票数、考勤管理的上下班签到的制定、部门管理的添加和编辑部门、员工管理的删除和编辑员工的基本信息、规章制度中的基本信息管理等（9）企业招聘培训中的招聘管理可以查看、是否通过或者取消的功能，求职管理中的查询、求职的通过或取消等功能，家教管理的查看信息、是否通过或取消，公寓管理的信息查看、通过或取消信息，培训管理的信息查询、通过或者取消信息，寻求合作管理的查看信息、是否通过或者取消发布信息，发布信息管理中的管理员发布所需要的基本信息，编辑信息并发布在网站的首页（10）企业媒体教程的语音管理和视频管理，语音管理中的查询管理的基本信息和是否删除和查看语音留言管理等功能，在视频管理中可以查看视频的基本信息和是否删除视频教程，查看视频留言的管理等信息（11）企业系统管理中的添加用户，修改密码，数据备份，数据初始化，恢复数据，会员管理。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
＜项目/产品名称＞模块（任务）开发卷宗
修订历史记录
目录
1简介 (3)
2模块(任务)开发情况表 (3)
3功能说明 (3)
4设计说明 (3)
5源代码（文件）清单 (4)
6测试说明 (4)
7复审的结论 (4)
1简介
2模块(任务)开发情况表
3功能说明
【扼要说明本模块(任务)（或本组模块(任务)）的功能，主要是输入、要求的处理、输出。
】
4设计说明
【说明本模块(任务)（或本组模块(任务)）的设计考虑，包括：
a．在系统设计说明书中有关对本模块(任务)（或本组模块(任务)）设计考虑的叙述，包括本模块(任务)在软件系统中所处的层次，它同其他模块(任务)的接口；
b．在程序设计说明书中有关对本模块(任务)（或本组模块(任务)）的设计考虑，包括本模块(任务)的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；
c．在编制目前已通过全部测试的源代码时实际使用的设计考虑。
d．数据库设计说明】
5源代码（文件）清单
【给出该模块(任务)的文件列表和配置说明】
6测试说明
【说明直接要经过本模块(任务)（或本组模块(任务)）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
】
7复审的结论
【把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。
】。