软件文档写作实训报告Word文档格式.docx
《软件文档写作实训报告Word文档格式.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训报告Word文档格式.docx（25页珍藏版）》请在冰点文库上搜索。
第3章实例3
3.1******实例3
3.2******实例3
第4章实训日记4
第5章实训总结5
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档的作用：
软件文档在软件开发中占有突出的地位和相当的工作量。
高效率、高质量的开发、分发、管理和维护对转让、变更、修正、扩充和使用文档。
对充分发挥软件产品的效益有着重要意义。
软件文档的作用如下：
1）
项目管理的依据。
文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。
2）
技术交流的语言。
项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。
3）
项目质量保证。
文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。
4）支持培训与维护.合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。
5）支持软件维护。
软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；
软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。
6）
记载软件历史。
软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。
良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。
软件文档分类：
从形式上来看，大致可分为两类：
1）是开发过程中填写的各种图表，可称之为工作表格。
2）是应编制的技术资料或技术管理资料，可称之为文档或文件。
按照文档产生和使用的范围，软件文档大致可分为三类：
1）开发文档：
这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
2）管理文档：
这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
3）用户文档：
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、数据要求说明书、软件需求说明书。
2.2软件文档所采用的标准
根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：
国际标准、国家标准、行业标准、企业（机构）标准、项目（课题）标准。
ISO
9000标准概述：
9000是国际标准化组织建立以来制订和公布的几千个标准中，影响最深远和普及最迅速的一个，其对各国经济生活所起的以下特点作用不可低估。
我们在观察这一现象时，注意到ISO
9000的以下几个特点：
（1）
国际性。
9000已成为各国对质量保证和质量管理制度的共同理解。
（2）
完整性。
9000系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准，形成了一个完整的体系结构。
（3）
兼容性。
作为ISO
9000系列标准核心的三个质量保证标准是逐一包容的。
即9001标准的内容最全面，9002标准排除了设计工作的质量要求，仅限于生产制造过程，9003标准仅限于检验和试验工作的质量要求。
可以说，依次适用范围渐窄。
（4）
主动性。
选用和实施ISO
9000标准、建立质量体系的主体，是企业的主动行为。
（5）
可信性。
9000的认证是授权认证机构对供方质量体系进行的独立、公正的活动，因此，具有相当的说服力和可信度。
（6）
指导性。
9000标准文本只是给出了质量管理和质量保证的原则，具体如何实施，需要供方结合自身机构的实际情况，特别是供方企业文化，进行创造性的解决。
（7）
科学性。
9000标准的背后是现代质量管理的科学原理。
（8）
实践性。
具体表现在，标准文本不是空洞的条文，并基于大量的质量管理实践。
如标准可向前追溯，得知其源于英国国家标准和美国军用标准等。
2.2软件文档的主要内容
我所做的软件文档是实验室设备管理系统软件文档。
其具体内容如下实验室设备管理系统。
分为4个子功能模块：
业务信息模块、业务管理模块、报表输出模块、用户管理模块。
第3章实例
3.1实验室设备管理系统可行性研究报告事例
实验室设备管理系统可行性研究报告（GB8567-2006）
1引言
1.1编写目的
随着高校规模的扩招，学生数量越来越多，为了适应学生所需资源的需要，因此高校的实验室设备也必然随着增加，设备增加势必在人手工的管理上花费很多的时间，而且效率不怎么高。
那这样开发一个既有设备信息录入，又可以查询设备的情况，还能输出报表的计算机化的管理系统对实验室设备的管理就显得非常有必要了。
1.2背景
a．实验室设备管理系统（laboratoryequipmentmanagementsystem）。
业务信息模块、业务管理模块、报表输出模块、用户管理模块；
b．本项目的任务提出者辽宁工业大学软件学院，开发者是信管1班王楠、1班刘骁宇、1班孟祥磊、3班白刚。
1.3定义
MIS：
管理信息系统
DataProcessing：
数据处理
TransactionProcessing：
事务处理
DataProcesssingCycle：
数据处理流程
MSD：
模块结构图
1.4参考资料
列出有关的参考资料：
a．张海藩.《软件工程导论》（第5版），清华大学出版社；
b．GB-T8567-1988计算机软件产品开发文件编制指南，国家标准局，1988-01-07发布，1988-07-01实施；
2可行性研究的前提
说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。
2.1要求
主要功能：
对实验室设备使用情况进行统计、更新，以方便实验室设备管理员对设备使用情况的查询。
性能要求：
对于所有设备都在该系统中有记录，对于需要维修和购买的设备能够在该系统中被查询显示出来。
技术要求：
每件设备在做入库登记时均由系统按类别加自动顺序号编号，形成设备号；
设备报废时要及时修改相应的设备记录，且有领导认可。
输入要求：
新设备信息、修理信息、申请购买信息、具体查询统计要求。
输出要求：
设备购买申请表、修理/报废注销/设备资金统计表。
在安全与保密方面的要求
同本系统相连接的其他系统
完成期限：
2013年12月10日之前
2.2目标
系统实现后，能够及时反映实验室的设备使用情况及缺乏何种设备，能够让实验室管理员及时做好对实验室的布置，从而提高了工作运行效率和效果。
2.3条件、假定和限制
建议软件寿命：
8年。
硬件条件：
服务器sun工作站，终端为pc机。
运行环境：
本系统针对MicrosoftWindows系统开发。
运行于Windows2000、WindowsXP,建议硬件配置PII以上64M内存300M硬盘空间。
数据库：
SQL、VisualBasic
投入运行最迟时间：
2013年12月10日
2.4进行可行性研究的方法
该项目的开发主要分为4步：
1.需求分析和设计阶段2.代码编写和调试阶段3.系统测试阶段4.系统维护和完善阶段。
在这四部分工作中的主要的工作就是熟悉和了解我校实验室的管理机制，然后设计系统的结构和功能。
在经过分析后依照设计编写代码和测试，最后协同实验室完善软件的功能。
软件开发者不向用户提供源代码和软件开发详细文档。
2.5评价尺度
成本/效益分析结果：
效益>
成本。
技术可行：
现有技术可完全承担开发任务。
操作可行：
软件能容易让管理员学会使用
3对现有系统的分析
现在我校的实验室都没有使用计算机统一管理。
仍然是手工管理，所以急需这类软件。
在实验室的终端安装windows2000的PC机，在领导办公室安装windows2000的PC机，主要目的是向领导的PC机传递数据，对于急需修改但又缺少的设备，以申请表的形式向领导发出购买请求。
3.1处理流程和数据流程
3.2工作负荷
每学年要对实验室设备使用情况进行统计、更新。
其中：
（1）对于已彻底损坏的做报废处理，同时详细记录有关信息。
（2）对于由严重问题（故障）的要及时修理，并记录修理日期、设备名、编号、修理厂家、修理费用、责任人等。
（3）对于急需修改但又缺少的设备，需以“申请表”的形式送交上级领导请求批准购买。
新设备购入后要立即进行设备登记（包括类别、设备名、编号、型号、规格、单价、数量、购置日期、生产厂家、保质期和经办人等信息），同时更新申请表的内容。
（4）随时对现有设备及其修理、报废情况进行统计、查询，要求能够按类别和时间段等查询。
3.3费用开支
列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开支总额。
3.4人员
列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。
3.5设备
以WindowXP为平台，系统采用SQLServer2000构建关系型数据库，使用VisualBasic语言
3.6局限性
列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足，处理功能不够等。
并且要说明，为什么对现有系统的改进性维护已经不能解决问题。
4所建议的系统
本章将用来说明所建议系统的目标和要求将如何被满足。
4.1对所建议系统的说明
系统采用SQLServer2000构建关系型数据库,使用C++对数据进行操作。
数据库在SQLServer2000中创建成功后，需要将上面的数据库概念结构转化为SQLServer2000数据库系统所支持的实际数据模型,也就是数据库的逻辑结构。
在上面的实体与实体关系的基础上,形成数据库中的表格以及各个表格之间的关系。
这可以利用SQLServer2000数据库系统中的SQL查询分析器实现。
4.2处理流程和数据流程
顶层数据流图：
0层数据流图：
1层数据流图：
4.3改进之处
由数据库的支持。
。
4.4影响
说明在建立所建议系统时，预期将带来的影响，包括：
4.4.1对设备的影响
PC机的性能不需要太高就可以满足软件的需求。
4.4.2对软件的影响
适用于Windows系列操作环境下。
4.4.3对用户单位机构的影响
可以提高实验管理员的工作效率，使管理员感觉到管理实验设备不是一件复杂的事，而是很轻松的。
4.4.4对系统运行过程的影响
1、可以导入导出数据。
2、可以备份，还原数据库。
3、减少维护的工作量，提高效率。
4.4.5对开发的影响
管理员只要输入简单的数据就可以完成设备管理。
4.4.6对地点和设施的影响
只需要管理员对该系统的操作，对地点没有过多的要求。
4.4.7对经费开支的影响
需要系统开发和系统维护的开支
4.5局限性
功能强大，操作就会复杂，不过只要熟悉几分钟就会管理设备了。
4.6技术条件方面的可行性
本节该系统使用SQLServer2000、C++等软件开发，主要难点是管理设备的算法，不过通过自己的努力是可以解决的。
5可选择的其他系统方案
扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。
5.1可选择的系统方案1
用VisualC++和数据库开发，不过VisualC++灵活性大，学起来困难。
5.2可选择的系统方案2
用java开发和数据库开发。
java可以跨平台，但是java的开发时间较长，也不行。
6投资及效益分析
6.1支出
（1）系统开发费用
①人员费用
本系统开发期10个周，试运行期4个周。
开发期需要开发人员5人，试运行期需开发人员2人。
人员费用为1万人民币。
②硬件设备费
系统所需的硬件设备费用为：
2.6万人民币，其中：
服务器1台8000元
微机2台6000元
打印机1台2000元
网络设备和布线1000元
不间断电源1台3000元
工作台2台600元
③咨询和评审费：
2000元
6.1.1基本建设投资
a.房屋和设施；
b.ADP设备；
c.数据通讯设备；
d.环境保护设备；
e.安全与保密设备；
f.ADP操作系统的和应用的软件；
g.数据库管理软件。
6.1.2其他一次性支出
a．研究（需求的研究和设计的研究）；
b．开发计划与测量基准的研究；
c．数据库的建立；
d．ADP软件的转换；
e．检查费用和技术管理性费用；
f．培训费、旅差费以及开发安装人员所需要的一次性支出；
g．人员的退休及调动费用等。
6.1.3非一次性支出
a．设备的租金和维护费用；
b．软件的租金和维护费用；
c．数据通讯方面的租金和维护费用；
d．人员的工资、奖金；
e．房屋、空间的使用开支；
f．公用设施方面的开支；
g．保密安全方面的开支；
h．其他经常性的支出等。
6.2收益
无
6.2.1一次性收益
a．开支的缩减包括改进了的系统的运行所引起的开支缩减，如资源要求的减少，运行效率的改进，数据进入、存贮和恢复技术的改进，系统性能的可监控，软件的转换和优化，数据压缩技术的采用，处理的集中化／分布化等；
b．价值的增升包括由于一个应用系统的使用价值的增升所引起的收益，如资源利用的改进，管理和运行效率的改进以及出错率的减少等；
c．其他如从多余设备出售回收的收入等。
6.2.2非一次性收益
说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。
6.2.3不可定量的收益
逐项列出无法直接用人民币表示的收益，如服务的改进，由操作失误引起的风险的减少，信息掌握情况的改进，组织机构给外界形象的改善等。
有些不可捉摸的收益只能大概估计或进行极值估计（按最好和最差情况估计）。
6.3收益／投资比
求出整个系统生命期的收益／投资比值。
6.4投资回收周期
求出收益的累计数开始超过支出的累计数的时间。
6.5敏感性分析
使用方面的可行性我们学院在没有使用我们这套系统前，采取的是人工方式，相对而言耗时大，效率低。
而根据现有的硬件条件已经学院的行政管理模式以及工作制度，在办公室中，管理设备的老师都配备电脑。
而且电脑的系统软件都是Windows2000以上的，所以足够可以来运行我们的软件：
从学院老师们的文化素质来看，我们的软件操作简单，运行方便，可用我们的软件来处理实验室设备管理系统。
7社会因素方面的可行性
本章用来说明对社会因素方面的可行性分析的结果，包括：
7.1法律方面的可行性
侵犯专利权：
有
侵犯版权：
为了能够解决在使用实验设备出现的一些问题，需要建立一个安全完善的管理平台，能够使设备信息能够快速完整地自动记录在案，并自动更新。
7.2使用方面的可行性
适用于实验室设备管理，系统操作简单，便于管理人员使用。
8结论
本次实验要求我们自己动手设计完成一个实验室设备管理系统，要求对实验室设备进行统计查询，对设备维修、报废情况的处理记录，能够申请购买新设备、更像申请表等。
本系统还要求用户登入具有一定的权限，能执行相关的操作。
当设备需要报废和购买还需要得到上级领导的审核批准。
3.2实验室设备管理系统数据库设计说明书实例
实验室设备管理系统数据库设计说明书（GB8567-2006）
实验室设备管理系统（laboratoryequipmentmanagementsystem）。
本项目的任务提出者辽宁工业大学软件学院，开发者是信管1班王楠、1班刘骁宇、1班孟祥磊、3班白刚。
张海藩.《软件工程导论》（第5版），清华大学出版社；
GB-T8567-1988计算机软件产品开发文件编制指南，国家标准局，1988-01-07发布，1988-07-01实施；
2外部设计
2.1标识符和状态
模块名称
标识符
模块功能
权限管理
1
管理用户权限
设备管理
2
实现设备的增删查改
调拨管理
3
实现调拨记录的增删查改
维修管理
4
实现维修记录的增删查改
组织管理
5
实现组织机构的增删查改
类型管理
6
实现类型信息的增删查改
类别管理
7
实现类别信息的增删查改
用户管理
8
实现用户的增删查改
修改密码
9
修改自身密码
2.2使用它的程序
设备管理系统
2.3约定
ＳＱＬ Ｓｅｒｖｅｒ２００５
2.4专门指导
权限管理模块是出于系统的安全性考虑实现用户的权限管理，要求规定用户级别，通过定义用户级别来实现权限控制，用户要使用该设备管理系统，首先要通过身份验证，根据不同的用户级别选择进入相应的用户主界面，结合session在不同页面间传递的级别信息设置相关功能按钮的可见性从而来实现权限控制。
2.5支持软件
硬件资源
联想奔腾IV微型计算机、主存1G、250GB硬盘、DVD光盘驱动器、HPLaser系列激光打印机
软件资源
Windows操作系统、MSSQLSERVER2005
3结构设计
3.1概念结构设计
●系统启动，激活身份验证模块
●管理人员登陆系统，系统初始化。
●管理人员手工输入维修设备信息，报废信息，若要购买设备，填写申请购买设备信息，并通过领导审核，购买新设备并录入设备信息。
●系统进行联机事务处理
●系统将录入信息插入到各个数据存储中
●系统根据用户需要进行报表输出，以及根据相应查询条件对现有设备及其修理、报废情况进行统计、查询
3.2逻辑结构设计
设备信息表
修理信息表
报废信息表
设备购买申请表
用户表
设备类别表
3.3物理结构设计
4运用设计
4.1数据字典设计
列名
数据类型
字段大小
必填字段
默认值
说明
Equip_ID
char
15
是
主键，设备编号
Type_ID
int
设备类型
Orter_ID
设备供应商
Equip_Date
datetime
购置日期
Equip_Price
money
设备金额
Equip_Year
保修年限
Usr_ID
16
null
设备使用者
Lab_ID
所属实验室
Equip_Else
varchar
200
备注
Equip_Lend
否
是否已外借
报废状态
是否报废
递增，主键
Lab_Name
实验室名称
LabAd_ID
50
实验室管理员编号
Admin_Name
主键，管理员名称
Admin_SecNum
管理员密码
Admin_Type
10
权限类型
Admin_Else
text
管理员备注
Times
记录用户进入系统前，密码错误次数
LabAd_Name
实验室管理员姓名
LabAd_Sex
男
实验室管理员性别
LabAd_Addr
实验室管理员住
升级会员 