生产实习课程设计GB2312 7.docx
《生产实习课程设计GB2312 7.docx》由会员分享，可在线阅读，更多相关《生产实习课程设计GB2312 7.docx（21页珍藏版）》请在冰豆网上搜索。
生产实习课程设计GB23127
辽宁工业大学
软件文档写作实训报告
题目：
教学资源管理与师生交互平台
院（系）:
软件学院
专业班级：
软件工程113班
学号：
111301062
学生姓名：
安凯辰
指导教师：
翟宝峰
教师职称：
副教授
起止时间：
2012.11.26-2012.12.2
实训任务及评语
院（系）：
软件学院教研室：
软件教研室
学号
111301062
学生姓名
安凯辰
专业班级
软件工程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软件文档的主要内容4
第3章实例6
3.1《教学资源管理与师生交互平台》数据库设计实例6
3.2《教学资源管理与师生交互平台》项目开发计划实例12
第4章实训日记15
第5章实训总结16
参考文献17
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。
正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
1.软件文档的定义,软件文档（document）也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。
它和计算机程序共同构成了能完成特定功能的计算机软件。
文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。
软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。
1）提高软件开发过程的能见度。
把开发过程中发生的事件以某种可阅读的形式记录在文档中。
管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
2）提高开发效率。
软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。
可在开发早期发现错误和不一致性，便于及时加以纠正。
3）作为开发人员在一定阶段的工作成果和结束标志。
4）记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。
5）提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。
使软件开发活动更科学、更有成效。
6）便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。
2.软件文档分类，软件文档从形式上来看，大致可分为两类：
一类是开发过程中填写的各种图表，可称之为工作表格，另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。
软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言（结构化语言），各类图形表示。
表格来编制文档。
文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。
按照文档产生和使用的范围，软件文档大致可分为三类：
1）开发文档：
这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
2）管理文档：
这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一些工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
3）用户文档：
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、维护修改建议、软件需求说明书。
2.2软件文档所采用的标准
1．根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：
1）国际标准：
ISO国际标准化组织，2）国际标准：
GB中国、ANSI美国、BS英国、JIS日本，3）行业标准：
IEEE，4）企业标准：
IBM，5）项目标准：
CIMS
2.基本标准包括：
1）软件工程术语，标准号为GB/T11457-1989；
2）信息处理——数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定，标准号为GB/T1526-1989；
3）软件工程标准分类法，标准号为GB/T15538-1995；
4）信息处理——程序构造及其表示法的约定，标准号为GB/T13502-1992；
5）信息处理——单命中判定表规范，标准号为GB/T15535-1995（ISO5806）；
6）信息处理系统——计算机系统配置图符号及其约定，标准号为GB/T14085-1993（ISO8790）；
3.开发标准包括：
1）信息技术——软件生存期过程，标准号为GB/T8566-1995；
2）软件支持环境，标准号为GB/T15853-1995；
3）信息处理——按记录组处理顺序文卷的程序流程，GB/T15679-1995（ISO6593）;
4）软件维护指南，标准号为GB/T14079-1993；
4.文档标准包括：
1）计算机软件产品开发文档编制指南，标准号为GB/T8567-1988;
2）计算机软件需求说明编制指南，标准号为GB/T9385-1988；
3）软件文档管理指南，标准号为GB/T16680-1996；
5.管理标准包括：
1）计算机软件配置管理计划规范，标准号为GB/T12505-1990；
2）信息技术——软件产品评价质量特性及其使用指南，标准号为GB/T16260-1996；
3）计算机软件质量保证计划规范，标准号为GB/T12504-1990；
4）计算机软件可靠性和维护性管理，标准号为GB/T14394-1993；
2.3软件文档的主要内容
1．软件开发文档
1）可行性研究报告:
陈述开发软件的目标、要求和限制条件，表达可行性研究的前提条件。
对现有系统的描述。
现有系统指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。
分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。
提出若干个新系统的建议方案，对每个方案的技术、经济和社会可行性进行分析。
可行性分析可以看做是一次简略的系统分析和系统设计过程。
所谓简略就是不必深入到低层数据元素，也无须考虑每个处理的细节。
在分析和设计的基础上得到的系统方案，才能成为进行技术、经济和社会可行性分析的对象。
2）软件需求文档:
尽管在进行可行性分析时已经确定了软件项目的一些可行方案，但由于分析和设计的过程较粗，其目的只是在较短时间内确定问题并分析问题是否存在。
所以软件需求分析的首要任务仍然是为待开发软件提供准确而详尽的要求，包括功能、性能、数据和运行环境等。
为下一阶段的概要设计提供目标和依据。
3）概要设计文档:
概要设计文档的主要任务是把系统的功能需求分配给软件机构，形成软件的系统机构图。
在软件的理论和工程的实践中，人们已经在采用各种表达软件构成的描述形式，构成了软件设计结构表达的一些规范。
4）数据库设计文档:
数据库设计说明书描述了一个数据库的设计，数据库是将一组相关数据存储为一个或多个计算机文件，并允许用户或计算机程序通过数据库管理系统（DBMS）访问这些数据。
它同时也描述了用来访问的软件模块。
5）详细设计文档:
在软件开发的工程化观点来看，在使用程序设计语言编制程序以前，需要对所采用算法的逻辑关系进行分析，设计出全部必要的过程细节，并给予了清晰的表达，使之成为编码的依据。
这就是详细设计的任务。
这个阶段的成果标志是详细设计说明书。
2．软件管理文档
1）项目开发计划:
项目开发计划又称为软件定义文档，和软件一个是重要的知识资产。
在开发活动中，项目计划是项目启动后的头一件重要的工作。
项目计划一般包括资源需求、工作分解、工作目标、开发团队及人员安排、进度安排、内外接口约定、风险分析及其软件质量监控机制。
2）测试计划:
为组装测试和确认测试所制定的实施计划，测试计划内容包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
软件测试就是在软件投入运行之前，对软件需求分析、设计规格说明和编码的最终复审，是软件质量保证的关键步骤，在软件开发的整个过程中占有极其重要的位置。
软件测试文档主要包括测试计划、测试策略、测试手段及其测试结果，最终将决定软件开发的成败。
测试工作在软件开发的整个过程中占有极其重要的位置，而人工测试又特别困难，所以测试过程的自动化成为测试的发展方向。
3）测试分析报告:
测试工作完成以后，应提交测试计划执行情况的说明。
对测试结果加以分析，并提出测试的意见。
4）开发进度报告:
开发进度报告是软件开发人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划于实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
编写开发进度报告的目的是及时向有关管理部门汇报开发的进展和情况，以便及时发现和处理开发过程中出现的技术问题、协调等问题。
3．用户文档
1）用户手册:
软件的质量是由多个方面构成的，用户手册也是平衡软件质量的一个重要标准。
特别是在当前软件快速增长的时期，软件开发者过于注重功能与性能而忽略用户手册，使得用户手册的质量问题尤显突出。
一个优秀的用户手册可以帮助用户快速入门，是用户正确、充分使用软件的前提。
对于开发者来说，好的用户手册可以减少培训和售后服务的费用。
所以，应该充分认识用户手册的重要性，提高用户手册的质量，以促进软件整体质量的一个提高。
2）操作手册:
操作手册是指导具体操作的工具书，它涉及软件设计完成后用户所关心的有关操作的内容。
由于操作的项目不同，操作手册的内容和形式也有不同，形式上有技术指导书、操作规程等类型，内容伸缩性较大。
3）维护修改文档:
软件产品投入运行以后，可能要一直使用若干年。
由于业务、政策、市场、法规、管理以及技术等方面的发展和变化，都会使得一个机构的业务经历着持续不断的变化，这些变化或者产生了新的需求，或者需求修改原来的软件需要，再好的软件系统都需要随着业务的变化而变化，因此，软件在其运行的生命周期中也是不断进行着维护修改工作的。
第3章实例
3.1《教学资源管理与师生交互平台》数据库设计实例
《教学资源管理与师生交互平台》数据库设计实例，采用的是（GB8568-88）标准。
数据库设计说明书（GB8567——88）
1引言
1.1编写目的
本文档为数据库设计文档，其关联文档包含有模块详细设计及需求内容，这篇文档的目的，确认数据库设计规范。
文档面对公司部门主管、公司董事会成员。
文档面对公司技术管理部成员。
1.2背景
开发软件的名称：
教学资源管理与师生交互平台
项目任务提出者：
辽宁工业大学软件学院教师
项目开发者：
辽宁工业大学软件学院软件工程专业2011级：
王阳、郎欢、尼钧元
用户：
在校学生和教师
实现软件者：
本小组
本系统采用B/S，服务器端采用TOMCAT6.0为操作系统的工作站
1.3定义
缩写、术语
解释
SPP
精简并行过程，SimplifiedParallelProcess
SD
系统设计，SystemDesign
1.4参考资料
《实用软件文档写作》清华大学出版社
《数据库原理教程》科学出版社
《软件工程》高等教育出版社
《软件工程方法与实践》机械工业出版社
《软件设计文档国家标准》GB8567-88
2外部设计
2.1标识符和状态
系统采用SQLSERVER2000做为后台数据库,数据库名称为DB_WY。
数据库中一共建立了9个表,表名分别为admin管理员表，s_work作业批改表，t_subject课程班信息，t_work作业表，ts_article文章信息表，ts_news留言信箱表，ts_sortid网站板块表，ts_users用户信息表，ts_log网站日志表。
附注:
1.此表仅是暂时使用的仅用于测试
2.此表的有效时间到此项目完成时
2.2约定
本系统采用SQLSERVER2000为基本开发工具，因而程序员或者系统分析员，或者任何想要使用此数据库进行操作的人员，需要安装SQLSERVER2000，并建立相同的数据库，当然可以进行联机访问，这需要安装相应的插件。
数据库中所建立的表名如（2.1标识符和状态），对于表的各个属性，在下面会有描述
2.3专门指导
对于从事此数据库的生成、此数据库的测试、维护的人员和老师，提出如下参考意见：
数据库的输入统一采用键盘。
由于现在没有设置权限，故只要不违背基本的限制，所有的操作都是可以进行的。
可是对于本系统需要的数据，却是有数据长度限制的，尤其是有说明的部分，所以测试人员在具体进行数据测试时，要注意数据输入格式。
2.4支持软件
本系统使用SQLSERVER2000做为后台数据库，在安装好SQLSERVER2000后还要安装SP4补丁以保证数据库可以正常访问。
JDBC驱动程序，保证程序可以和数据进行连接。
3结构设计
3.1概念结构设计
数据库中包括的实体有管理员，作业，教师，学生，文章，文章分类，留言信息，网站日志，班级。
1.管理员实体包括属性编号，用户名，密码和状态。
如图3.1
图3.1管理员实体
2.教师实体包括属性编号，用户名，密码，姓名和昵称。
如图3.2
图3.2教师实体
3.学生实体包括属性编号，用户名，密码，姓名和昵称。
如图3.3
图3.3学生实体
4.作业实体包括属性编号，班级号和作业名。
如图3.4
图3.4作业实体
5.班级实体用来创建学生和老师之间的关系，其中包括班级编号、学生编号和教师编号。
如图3.5
图3.5班级实体
6.留言信息实体，括了留言编号，留言发送者，留言接收者，留言标题，留言内容，留言创建时间和留言状态。
如图3.6
图3.6留言信息实体
7.文章分类实体，包括版块编号，版块名称。
如图3.7
图3.7文章分类实体
8.文章实体包括属性，文章编号，标题，文章作者，发布时间，文章状态，文章中可下载的文件名称，所属板块和点击次数。
如图3.8
图3.8文章实体
9.总体E-R图。
如图3.9
图3.9总体E-R图
3.2逻辑结构设计
表3.1为数据库中所有表总汇包括各个表中的英文名称，中文名称及其功能
表3.1数据库表总汇
英文表名
中文表名
功能说明
s_work
作业批改表
存储学生提交作业的批改情况以及分数
t_subject
课程班信息
用于存储课程班信息包括学生学号和教师号
t_work
作业表
用于存储作业信息
ts_article
文章信息表
用于存储网站中文章的信息
ts_news
留言信箱表
用于存储用户间所发送的留言信息
ts_sortid
网站板块表
用于存储网站中个个大板块的名称
ts_users
用户信息表
用于存储网站用户的个人信息
ts_log
网站日志表
用于存储网站中所有操作的信息
1.用户表（ts_users）:
存储用户的信息数据其中包括，用户名，密码，用户真实姓名，昵称，用户状态和用户权限信息。
如表3.2
表3.2用户信息表
列名
数据类型
长度
空/非空
约束条件
注释
userid
varchar
15
N
PK
用户名
username
varchar
20
Y
用户真实姓名
userpwd
varchar
20
N
用户密码
Nickname
Varchar
20
Y
用户昵称
Status
int
4
N
用户状态1正常2删除
Qx
Int
4
N
用户权限1教师2学生
2.网站板块信息表（ts_sortid）:
用于存储当前网站的板块信息，其中包括板块的编号和板块名称。
如表3.3
表3.3网站板块信息表
列名
数据类型
长度
空/非空
约束条件
注释
id
Int
4
N
PK
网站板块编号
name
Varchar
20
N
网站板块名称
3.网站板块内容表（ts_article）:
用于存储网站的文章信息，其中包括文章编号，标题，内容，文章作者，发布时间，文章状态，文章中可下载的文件名称，所属板块和点击次数。
如表3.4
表3.4网站文章信息表
列名
数据类型
长度
空/非空
约束条件
注释
id
Int
4
N
PK
网站文章编号
title
Varchar
100
N
文章标题名称
content
Varchar
8000
Y
文章内容
Author
Varchar
20
N
文章作者
createtime
datetime
8
N
文章的发布时间
Flag
Int
4
N
文章当前状态1发布2未发布
Filename
Varchar
200
N
文章附件的文件名称
Sortid
Int
4
N
文章所对应板块
hit
Int
4
N
文章的查看次数
4.留言信箱信息表（ts_news）:
用来存储用户之间的留言信息，其中包括了留言编号，留言发送者，留言接收者，留言标题，留言内容，留言创建时间和留言状态，其中留言状态分为2类，分别是未读和已读。
如表3.5
表3.5用户留言信箱信息表
列名
数据类型
长度
空/非空
约束条件
注释
id
int
4
N
PK
留言编号
sender
varchar
20
N
发送者用户名
recever
varchar
20
N
接收者用户名
topic
Varchar
50
N
留言标题
content
Varchar
500
N
留言内容
Createtime
datetime
8
N
发送留言的时间
Flag
Int
4
N
留言状态1未读2已读
5.作业信息表（t_work）:
用来存储课程班的作业信息，其中包括作业编号，课程班编号和作业内容。
如表3.6
表3.6作业信息表
列名
数据类型
长度
空/非空
约束条件
注释
id
int
4
N
PK
作业编号
subjectid
int
4
N
课程班编号
workname
varchar
60
N
作业内容
6.作业作业提交及审批表（s_work）:
用来存储课程班的学生提交作业的信息以及作业的批改情况信息，其中包括提交作业编号，学生用户名，作业编号，作业分数，作业评语，作业状态和附件名称。
如表3.7
表3.7作业提交及审批表
列名
数据类型
长度
空/非空
约束条件
注释
id
int
4
N
PK
提交作业编号
student
varchar
20
N
学生编号
workid
int
4
N
作业编号
Score
Int
4
Y
作业得分
Opinion
Varchar
40
Y
作业评语
Status
Int
4
N
作业批阅状态1已批阅2未批阅
filename
Varchar
20
N
提交作业附件
3.3物理结构设计
相对于逻辑设计中的实体大部分可以转换成物理设计中的表，但是它们并不一定是一一对应的，以下的说明，为经过规划以后的详细的设计表格。
实际上的设计是基于优化、实际数据存储等多方面因素考虑而形成的，其中加入了一些虚拟的元素，这些元素是报表设计、系统设计的一个中间件。
数据库表设计原理与实现方案将在模块设计文档中体现。
数据库规划方案和规划原理将在详细设计中讨论。
一些其他库表作用，规则也将在详细设计和扩展中讨论。
4运用设计
4.1安全保密设计
用户只能用该用户的帐号登陆到应用软件，通过应用软件访问数据库，而没有其它途径操作数据库。
系统构架采用三层结构，中间层为应用服务器，用户层仅对中间层操作。
用户层不能访问数据库应用服务器。
数据库服务器禁止用户直接访问，仅能通过中间层访问。
提高软件系统的安全性应当从“管理”和“设计”两方面着手。
这里仅考虑数据库的安全性设计，在管理层面上，采用特定用户访问特定资源的办法实现，在规划层面上，尽量采用最小权限原则。
3.2《教学资源管理与师生交互平台》项目开发计划实例
《教学资源管理与师生交互平台》开发计划实例，采用的是（GB856T——88）标准。
项目开发计划（GB856T——88）
1引言
1.1编写目的
为了明确项目开发的目标和要求，明确任务进度，熟悉项目开发的基本流程和规范要求。
预期的读者主要有本项目开发小组成员：
王阳、郎欢、尼钧元.
1.2背景
说明：
本软件名称：
教学资源管理与师生交互平台
本项目提出者：
开发者有：
王阳、郎欢、尼钧元。
1.3定义
MyEclipse：
是一个十分优秀的用于开发Java,J2EE的Eclipse插件集合，MyEclipse的功能非常强大，支持也十分广泛，尤其是对各种开源产品的支持十分不错。
SQL:
SQL结构化查询语言，是一种数据库查询和程序设计语言，用于存取数据以及查询、更新和管理关系数据库系统。
1.4参考资料
王新颖《软件工程与文档编写》北京大学出版社2007.6
郑人杰《实用软件工程（第四版）》清华大学出版社2003.4
唐任仲《工程应用软件开发技术》化学工业出版社1999.5
潘孝铭《软件文档编写》高等教育出版社2004.2
肖刚
升级会员 