生产实习课程设计GB2312 5.docx
- 文档编号:27166574
- 上传时间:2023-06-27
- 格式:DOCX
- 页数:26
- 大小:68.34KB
生产实习课程设计GB2312 5.docx
《生产实习课程设计GB2312 5.docx》由会员分享,可在线阅读,更多相关《生产实习课程设计GB2312 5.docx(26页珍藏版)》请在冰豆网上搜索。
生产实习课程设计GB23125
辽宁工业大学
软件文档写作实训报告
题目:
教师信息管理系统软件文档
院(系):
软件学院
专业班级:
软件113
学号:
11301060
学生姓名:
安凯辰
指导教师:
翟宝峰
教师职称:
副教授
起止时间:
2012.11.26-2012.12.02
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
111301060
学生姓名
安凯辰
专业班级
软件113
实训题目
教师信息管理系统软件文档
实训任务
实训任务及要求:
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复,文档要严格按照所采用的标准编写,图表布局要合理规范。
指导教师评语及成绩
成绩:
指导教师签字:
年月日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准3
2.3软件文档的主要内容5
第3章实例6
3.1《教师信息管系统项目总结报告》实例6
3.2《教师信息管系统测试计划》实例8
第4章实训日记15
第5章实训总结16
参考文献17
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程,具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档可以分为开发文档和产品文档两大类。
开发文档包括:
《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。
产品文档包括:
《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。
一、开发文档:
1.《功能要求》--来源于客户要求和市场调查,是软件开发中最早期的一个环节。
客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。
有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。
这份文档是需求分析的基础。
2.《投标方案》--根据用户的功能要求,经过与招标方沟通和确认。
3.《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。
4.《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。
以《需求分析》为基础,进行详细的技术分析,列出本项目需要使用什么技术方案,有哪些技术问题要解决,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。
5.《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。
以《需求分析》为基础,进行详细的系统分析(产品的开发和实现方法),估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。
6.《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。
以《系统分析》为基础,进行详细的数据库设计。
必要时可以用图表解说,特别是关系数据库。
7.《功能函数文档》--包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。
以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。
8.《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。
9.《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。
10.《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。
11.《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。
二、产品文档:
1.《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。
2.《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。
一般用Power、point或者VCD录制软件实现。
3.《疑问解答》--列出用户关心的问题和处理方法。
用于解答软件的操作功能和解决用户的疑难问题。
4.《功能介绍》--以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。
5.《技术白皮书》--以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。
6.《评测报告》--第三方权威评测报告。
包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
7.《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
8.《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
9.《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。
10.《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。
2.2软件文档所采用的标准
软件文档的工作
参照其它工程领域对工程标准划分的方法,软件工程标准主要有两种划分方法:
按标准的类型划分和按标准的范围划分。
一、按标准的类型划分:
按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。
过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。
过程标准使用一组方法、工具和技术,给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。
产品标准则涉及软件工程事务的格式和内容。
软件开发和维护活动文档化的结果就是软件产品,软件文档是软件工程活动进一步开展的基础。
软件开发作为一种行业,其行业标准涉及软件工程的所有方面,如职业认证、职业培训、产品许可等。
行业标准可以等同于行业行为规范。
记法标准规定了在软件工程行业范围内,以唯一的方式进行交流的方法,如术语、表示法、语言等。
它其实是一种语境规范。
二、按标准的范围划分:
按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。
任务功能可以表示软件工程过程,可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。
产品工程功能包括定义、生产和支持最终产品所必须的过程。
验证和确认功能是检查产品质量的活动。
技术管理功能是构造和控制产品工程的过程。
这3个部分并不集中在单个的软件生存周期里,而是并行进行的生产、检查和控制活动。
国家标准局在1988年1月发布了
《计算机软件开发规范》《软件产品开发文件编制指南》
作为软件开发工作的准则和规程。
它们基于软件生存期方法,把软件产品从形成概念开始,经过开发、使用和不断增补修订,直到最后被淘汰的整个过程应提交的文档归于以下十三种。
一。
可行性研究报告
说明该软件项目的实现在技术上、经济上和社会因素上的可行性;
评述为合理地达到开发目标可供选择的各种可能的实现方案;
说明并论证所选定实施方案的理由。
二。
项目开发计划
为软件项目实施方案制定出的具体计划。
它包括
各部分工作的负责人员,开发的进度,开发经费的概算,所需的硬件和软件资源等。
项目开发计划应提供给管理部门,并作为开发阶段评审的基础。
三。
软件需求说明书
对目标软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
四。
数据要求说明书
给出数据逻辑描述和数据采集的各项要求,为生成和维护系统的数据文件做好准备。
五。
概要设计说明书
该说明书是概要设计工作阶段的成果。
它应当说明
系统的功能分配,模块划分,程序的总体结构,输入输出及接口设计,运行设计,数据结构设计,出错处理设计等,为详细设计奠定基础。
六。
详细设计说明书
着重描述每一个模块是如何实现的,包括实现算法、逻辑流程等。
七。
用户手册
详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。
八。
操作手册
为操作人员提供软件各种运行情况的有关知识,特别是操作方法细节。
九。
测试计划
针对集成测试和确认测试,需要为组织测试制定计划。
测试的内容,进度安排,条件,人员,测试用例的选取原则,测试结果允许的偏差范围
十。
测试分析报告
测试工作完成后,应提交测试计划执行情况的说明。
对测试结果加以分析,并提出测试的结论性意见。
十一。
开发进度月报
该月报是软件人员按月向管理部门提交的项目进展情况的报告。
报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
十二。
项目开发总结报告
软件项目开发完成之后,应当与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。
还需对开发工作作出评价,总结经验和教训。
十三。
维护修改建议
软件产品投入运行之后,可能有修正、更改等问题,应当对存在的问题、修改的考虑以及修改的影响估计等做详细的描述,写成维护修改建议,提交审批。
以上软件文档是在软件生存期中,随着各个阶段工作的开展适时编制的。
其中,有的仅反映某一个阶段的工作,有的则需跨越多个阶段。
软件生存期各阶段与各种文档编制的关系
2.3软件文档的主要内容
文档最终要向软件管理部门,或向用户回答下列问题
哪些需求要被满足(What);软件在什么环境中实现,所需信息从哪里来(Where);开发时间如何安排(When);开发(或维护)工作打算由谁来做(Who);需求应如何实现(How);为什么要进行这些软件开发或维护修改工作(Why)。
对文档编制的质量要求
如果不重视文档编写工作,或是对文档编写工作的安排不当,就不可能得到高质量的文档。
质量差的文档使读者难于理解,给使用者造成许多不便会削弱对软件的管理(难以确认和评价开发工作的进展情况),提高软件成本(一些工作可能被迫返工)造成误操作对编制高质量文档的要求
1.针对性
文档编制以前应分清读者对象。
按不同的类型、不同层次的读者,决定怎样适应他们的需要。
管理文档主要面向管理人员用户文档主要面向用户这两类文档不应像开发文档(面向开发人员)那样过多使用软件的专用术语。
2.精确性
文档的行文应当十分确切,不能出现多义性的描述。
同一课题几个文档的内容应当是协调一致,没有矛盾的。
3.清晰性
文档编写应力求简明,如有可能,配以适当的图表,以增强其清晰性。
4.完整性
任何一个文档都应当是完整的、独立的,它应自成体系。
例如,前言部分应做一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。
同一课题的几个文档之间可能有些部分内容相同,这种重复是必要的。
不要在文档中出现转引其它文档内容的情况。
如,一些段落没有具体描述,用“见××文档××节”的方式.
5.灵活性
各个不同软件项目,其规模和复杂程度有着许多实际差别,不能一律看待。
应根据具体的软件开发项目,决定编制的文档种类。
软件开发的管理部门应该根据本单位承担的应用软件的专业领域和本单位的管理能力,制定一个对文档编制要求的实施规定。
对于一个具体的应用软件项目,项目负责人应根据上述实施规定,确定一个文档编制计划。
其中包括:
编制哪几种文档,详细程度如何,各文档的编制负责人和进度要求,审查/批准负责人和时间进度安排,在开发时期内各文档的维护、修改和管理的负责人,以及批准手续,有关的开发人员必须严格执行这个文档编制计划。
当所开发的软件系统非常大时,一种文档可以分成几卷编写。
例如,
项目开发计划可分写为:
质量保证计划,配置管理计划,用户培训计划,安装实施计划等。
系统设计说明书可分写为:
系统设计说明书,子系统设计说明书。
程序设计说明书可分写为:
程序设计说明书,接口设计说明书,版本说明。
操作手册可分写为:
操作手册,安装实施过程。
测试计划可分写为:
测试计划,测试设计说明,测试规程,测试用例。
测试分析报告可分写为:
综合测试报告,验收测试报告。
项目开发总结报告也可分写成:
项目开发总结报告,资源环境统计。
第3章实例
3.1《教师信息管系统项目总结报告》实例
项目开发总结报告(GB8567——88)
1引言
1.1编写目的
该项目开发总结报告是对本次系统的开发全部工作的总结,对各个工作成员的具体工作的总结。
让团对能够全面的认识与掌握自己的优势与缺点。
同时也让上级能够全面的了解整个开发系统的各个步骤及对系统的认识。
本软件测试计划说明的读者对象是系统开发人员,受理任务的人员。
1.2背景
开发系统软件名称:
教师信息管理系统;
本项目的任务提出者是学校信息管理系统的各位老师,由本小组负责开发,用于辽宁工业大学软件学院的老师信息管理。
开发背景:
本系统属于辽宁工业大学软件学院的老师信息管理模块,实现的是网络管理中关于学生成绩管理的子系统,通过此软件,提高软件工程分析问题,解决问题的能力,同时增强对数据库的使用能力。
1.3定义
VisualC#——C#是微软开发的一种面向对象的编程语言,是微软.NET开发环境的重要组成部分。
而MicrosoftVisualC#2005是微软开发的C#编程集成开发环境(同种产品还有Borland公司的C#Builder),它是为生成在.NETFramework上运行的多种应用程序而设计的。
1.4参考资料
张海藩,《软件工程导论》,清华大学出版社
陆丽娜,《软件工程》,经济科学出版社
萨师煊,《数据库系统概论》,高等教育出版社
薛华成,《管理信息系统》,清华大学出版社。
2实际开发结果
2.1产品
说明最终制成的产品,包括:
程序系统中包括学生成绩查询模块,教师成绩管理模块,管理员模块,学生成绩查询时在账号及学号进入界面后能够对其的选修课与必修课成绩查询,但是不能修改,可以对自己的密码进行修改。
教师可以上传成绩。
管理员可以对教师信息,学生信息,课程信息进行修改与添加。
但是不能对其成绩进行改变。
他们数据时建立了表单,存放在数据库中,通过关键字与外关键字使他们产生联系。
最终存取与提取数据。
学生成绩管理系统,运行,教师登录界面是教师号与初始密码111111,学生是用户名是学号,初始密码是111111。
建立的数据库database。
在运行该系统式要配置一定的虚拟服务器。
。
2.2主要功能和性能
老师信息查询模块:
老师信息查询时在账号及学号进入界面后能够对其的选修课与必修课成绩查询,但是不能修改,可以对自己的密码进行修改。
教师成绩管理模块:
教师可以上传成绩,对自己的账号密码可以修改。
管理员模块:
管理员可以对教师信息,学生信息,课程信息进行修改与添加。
但是不能对其成绩进行改变。
本系统基本达到我们预设的全部功能,并希望在以后的使用中逐渐完善。
2.3基本流程
2.4进度
计划在2012年12月2号提交,提前5天完成任务。
提前的原因是团队的合作精神强烈。
2.5费用
无。
3开发工作评价
3.1对生产效率的评价
程序的平均生产效率10000行/月;
文件的平均生产效率,每人5000字/月生产的;
与原计划符合。
3.2对产品质量的评价
最终发布版本质量尚可,目前并没有大漏洞出现,但在开发过程中出项了很多不应该的错误,比如对字符串使用赋值符号等常识性错误。
3.3对技术方法的评价
A目前是一个发展比较成熟的编程方式,所以技术方法是没有问题。
3.4出错原因的分析
给出对于开发中出现的错误的原因分析。
团队的沟通在开始项目前没有做好协商,而且以前编程太少,对程序的驾驭能力还够强。
以及对的网页编程还不太熟。
4经验与教训
经过这次开发,我们尽力了从需求分析到成品发布的全部过程。
从中我们认识到,要开发一个软件产品,必须对它所有涉及到的各个方面都要有所了解。
关键地方必须熟悉。
作为设计者的系统分析阶段,必须对不同模块的联系,工作量有正确的认识才能合理的分配任务。
管理者要时刻保持清醒,要有合理的进度和质量的控制,才能保证按时按量的完成任务。
这次最大的教训是,对进度的掌握不是很好,整个项目的进度没有一定的节奏,忽快忽慢的。
幸好最后按时完成了任务。
管理者的头脑不清楚,就会导致整个团队走很多的弯路。
所以一个领导者是非常重要的。
项目是要在过硬的技术基础上有严格的管理,才能确保工程的质量与数量同时得到满意的效果。
3.2《教师信息管系统测试计划》实例
测试计划(GB8567——88)
1引言
1.1编写目的
测试是“为了发现程序中的错误而执行程序的过程”。
测试的目的就是在软件投入生产性运行之前,尽可能多的发现软件中的错误。
目前软件测试仍然是保证软件质量的关键步骤,它是对软件规格说明.设计和编码的最后复审,也是必不可少的关键步骤。
由于在开发软件的过程中,开发人员会面对极其错综复杂的问题,我们开发设计人员,用户,委托公司等的主观认识不可能完全符合客观现实,同时与工程密切相关的各类人员之间的通信和配合也不可能完美无缺,甚至会出现分歧或是对同一事物理解的偏差。
因此,在软件生命周期的每个阶段都不可避免地会产生差错。
在教务系统这类用户类型固定为学生,教师及教务管理人员,但涉及到学校教学管理的信息管理系统中,就必须尽量减少差错,以免造成严重的损失。
因此,软件测试对整个软件的开发是不可或缺的,而一份完整的测试计划在开发流程里也是必须的。
此份软件测试计划的读者包括:
软件开发设计人员,项目管理人员,软件测试人员。
1.2背景
开发软件名称:
教师信息管理系统
项目任务提出者:
辽宁工业大学软件学院翟宝峰副教授
项目开发者:
实验小组
用户:
实验小组
实现项目测试的部门:
文烈。
1.3定义
SQLSERVER:
系统服务器所使用的数据库管理系统(DBMS)。
SQL:
一种用于访问查询数据库的语言
事务流:
数据进入模块后可能有多种路径进行处理。
主键:
数据库表中的关键域。
值互不相同。
外部主键:
数据库表中与其他表主键关联的域。
OLLBACK:
数据库的错误恢复机制。
1.4参考资料
《华中科技大学本科学分制学籍管理条例》
《华中科技大学学分制选课办法》
《项目计划说明书》
《可行性研究报告》
《需求规格说明书》
2计划
2.1软件说明
为了提高测试效率降低测试成本,本测试方案采用黑盒法设计基本的测试方案,再用白盒法补充一些方案。
在黑盒法测试方案中,采用等价划分技术,把所有可能的输入数据(有效的和无效的)划分成几个等价类,其划分类在以下的输入中再详述。
以下列出的图表,逐项说明被测软件的功能、输入和输出等质量指标,以作为叙述测试计划的提纲:
功能
子功能
输入
输出
权限
管理功能
转专业管理
转专业申请单
转入批准单
教务管理人员
停学
停学记录单
停学审批表
教务管理人员
休学
休学记录单
新的学籍信息
教务管理人员
复学
复学记录单
新的学籍信息
教务管理人员
退学
退学记录单
新的学籍信息
教务管理人员
延长年限
延长年记录单
新的学籍信息
教务管理人员
注册管理
个注册操作
学号/注册命令
学号/姓名/班级/院系/注册状态
教务管理人员
班级注册操作
班级号/注册命令
班级号/院系/人数
教务管理人员
个人注册状态查询
学号
学号/姓名/班级/院系/注册状态
教务管理人员/学生
班级注册状态查询
班级号
班级号/院系/人数
教务管理人员
教师信息管理
教师信息查询
教师号
教师号/姓名/性别/年龄/执教时间/职称
教务管理人员/教师
教师添加
教师号/姓名/性别/年龄/执教时间/职称
新的教师信息
教务管理人员
教师修改
教师号/相关修改项
新的教师信息
教务管理人员
教师删除
教师号
删除确认信息
教务管理人员
学生信息管理
学生信息查询
学号(或姓名)
学号/姓名/性别/班级/院系/家庭住址/身份证号
教务管理人员/学生(学生登录后系统显示已注册的学生信息)
学生添加
学号/姓名/性别/班级/院系/家庭住址/身份证号
添加确认信息
教务管理人员
学生修改
学号(或姓名)/相关修改项
学号/姓名/性别/班级/院系/家庭住址/身份证号
教务管理人员
学生删除
学号
删除确认信息
教务管理人员
成绩管理
成绩录入
成绩信息
成绩报表
教师
个人成绩报表
学号/学期信息
个人学期成绩报表/个人学年成绩报表/个人综合成绩报表
教务管理人员/学生
班级成绩报表
学年/班级号
班级学年加权统计表/班级学分统计表/班级综合加权成绩表
教务管理人员
年级成绩报表
年级
年级加权成绩一览表
教务管理人员
课程管理
课程信息查询
课程号
课程号/课程名/课程性质/学分/课时/授课教师
教务管理人员/学生/教师
课程添加
课程号/课程名/课程性质/学分/课时/授课教师
添加确认信息
教务管理人员
课程修改
课程号
课程
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 生产实习课程设计GB2312 生产 实习 课程设计 GB2312