软件文档写作 图书管理系统.docx
- 文档编号:15422054
- 上传时间:2023-07-04
- 格式:DOCX
- 页数:21
- 大小:37.35KB
软件文档写作 图书管理系统.docx
《软件文档写作 图书管理系统.docx》由会员分享,可在线阅读,更多相关《软件文档写作 图书管理系统.docx(21页珍藏版)》请在冰点文库上搜索。
软件文档写作图书管理系统
辽宁工业大学
软件文档写作实训报告
题目:
图书管理系统软件文档
院(系):
软件学院
专业班级:
软件技术班
学号:
学生姓名:
指导教师:
王彦华
教师职称:
助教
起止时间:
2010.11.22-2010.12.06
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
学生姓名
专业班级
软件技术
实训题目
图书管理系统软件文档
实训任务
实训任务及要求:
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软件文档的主要内容3
第3章实例5
3.1概要设计实例5
3.2用户手册实例11
第4章实训日记18
第5章实训总结19
参考文献20
第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)记载软件历史。
软件文档作为“记载软件历史的语言”,可用作未来项目的一种资源,向潜在用户报道软件的各种有利信息,便于他们判断自己是否需要该软件提供的服务。
良好的系统文档,显然有助于完成软件的移植,或将软件转移到各种新的系统环境中去。
图2.1文档桥梁作用
软件文档分类:
从形式上来看,大致可分为两类:
1)是开发过程中填写的各种图表,可称之为工作表格。
2)是应编制的技术资料或技术管理资料,可称之为文档或文件。
按照文档产生和使用的范围,软件文档大致可分为三类:
1)开发文档:
这类文档是在软件开发过程中,作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
2)管理文档:
这类文档是在软件开发过程中,由软件开发人员制定的需提交人员的一砦工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
3)用户文档:
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、数据要求说明书、软件需求说明书。
2.2软件文档所采用的标准
参照其它工程领域对工程标准划分的方法,软件工程标准主要有两种划分方法:
按标准的类型划分和按标准的范围划分。
一、按标准的类型划分:
按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。
过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。
过程标准使用一组方法、工具和技术,给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。
产品标准则涉及软件工程事务的格式和内容。
软件开发和维护活动文档化的结果就是软件产品,软件文档是软件工程活动进一步开展的基础。
软件开发作为一种行业,其行业标准涉及软件工程的所有方面,如职业认证、职业培训、产品许可等。
行业标准可以等同于行业行为规范。
记法标准规定了在软件工程行业范围内,以唯一的方式进行交流的方法,如术语、表示法、语言等。
它其实是一种语境规范。
二、按标准的范围划分:
按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。
任务功能可以表示软件工程过程,可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。
产品工程功能包括定义、生产和支持最终产品所必须的过程。
验证和确认功能是检查产品质量的活动。
技术管理功能是构造和控制产品工程的过程。
这3个部分并不集中在单个的软件生存周期里,而是并行进行的生产、检查和控制活动。
2.3软件文档的主要内容
我所做的软件文档是图书管理系统软件文档。
图书管理系统软件文档包括图书管理系统操作手册、图书管理系统测试计划、图书管理系统概要设计说明书、图书管理系统可行性分析报告、图书系统管理系统需求说明书、图书管理系统详细设计说明书、图书管理系统项目计划、图书管理系统项目总结报告、图书管理系统用户手册。
软件需求说明书:
也称软件规格说明书,其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
项目开发计划:
为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
项目开发计划应提供给管理部门,并作为开发阶段评审的参考。
数据要求说明书:
该说明书应给出数据逻辑描述和数据采集的各项要求,为生成和维护系统数据文卷作好准备。
概要设计说明书:
该说明书是概要设计阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计奠定基础。
详细设计说明书:
着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。
·
用户手册:
本手册详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。
第3章实例
3.1软件需求说明书实例
软件需求说明书
1引言
1.1编写目的
本说明书其主要目的是明确所要开发的软件应具有的功能、性能,使系统分析人员及软件开发人员能清楚地了解用户的需求,研究图书管理系统的总体需求、实现方案,并分析开发系统的可行性,为决策者提供是否开发该系统的依据和建议,并在此基础上进一步提出概要设计说明书和完成后续设计与开发工作,为软件开发范围、业务处理规范提供依据,也是应用软件进行合同终验的验收依据。
本文档的读者对象包括:
1)用户
2)系统分析人员
3)软件设计人员
4)软件实现人员
5)软件测试人员
1.2背景
本项目作为《软件文档写作》课程的训练项目的提出,可使我们了解软件文档的相关标准和编写原则,训练并掌握软件各类文档写作的技巧。
假设由于老的操作程序已经不适应了,辽宁工业大学图书馆为了更好的服务同学,提高业务能力,提出了新的系统要求。
他们的新系统要求一套实时,高效,便捷,完善,安全性好的图书管理软件系统。
应图书馆邀请,我小组招标,中标进行开发。
项目软件名称:
图书管理系统。
项目任务提出者:
辽宁工业大学图书馆。
项目开发者:
孙庆贺,麻志鹏,刘旭升,孟翔。
用户:
辽宁工业大学图书馆。
实现软件单位:
学校。
项目与其他软件,系统的关系:
开发的系统要求界面友好,方便直观。
既要方便管理员对图书信息进行添加、删除、修改、查询和统计等管理,又要方便学生借书、还书和续借等业务的办理。
将数据库发布到互联网上,进行资源共享,方便学生可以在自己的权限内对图书信息进行访问,查询相关信息和进行续借操作。
1.3定义
1)Socket:
套接字
2)TCP/IP:
传输控制协议/网络协议
3)I/O:
流输入输出
4)C/S:
客户端/服务器
5)OS:
操作系统
6)Serialize:
序列化
7)Deserialize:
反序列化
8)Lib:
图书管理系统。
1.4参考资料
(1)钱乐秋等,《软件工程》,清华大学出版社;
(2)张害藩,《软件工程导论》(第四版),清华大学出版社;
(3)王珊等,《数据库原理及设计》,清华大学出版社;
(4)赵池龙等,《软件工程实践教程》,电子工业出版社。
2任务概述
2.1目标
图书管理系统对于现代学校而言,是能否发挥其教学科研的作用的至关重要技术平台。
对于图书馆管理人员来说,是能否方便快速获取信息的关键。
所以图书管理系统应该能够为用户提供充足的信息和快捷方便的操作手段。
该系统开发的目的是方便图书馆的管理,可在最短的时间内查找到所需书籍的信息,用户信息,归还日期等具体信息。
基本目标如下:
1节约资源,减少很多不必要的浪费,不用像以前那样用冗余的纸张式的管理,大大节省了能源。
2计算机的存储与快速查询功能大大提高了图书馆管理的效率,并且还提高了图书馆信息管理的精确度。
3方便快速的操作,可减少图书信息管理的漏洞,又减少因工作的冗余出的错误,并且操作非常简单。
|
2.2用户的特点
该系统适合的用户有管理者和借阅者。
管理者可以查询用户信息,查询书籍信息,查询图书借阅情况以及对系统的维护。
需要一定的技术水平和专业知识。
借阅者可以查询图书信息,也可以对自己借书情况进行查询。
不需要掌握专业知识。
2.3假定和约束
本系统的开发期限为一个月。
完成项目的主要困难是对系统得完整性完善的不够好,缺少实际的经验。
3需求规定
3.1对功能的规定
表3.1功能说明
功能
说明
图书借阅和归还
把图书的借阅和归还情况写入系统
图书信息的修改和删除
修改和删除一些错误的图书信息
图书信息的查询
不同用户可以在自己的权限范围内进行有限制的图书信息查询
备份/导入图书信息
系统管理员有权利对图书信息的数据进行安全及有效的备份和导入
3.2对性能的规定
3.2.1精度
在精度需求上,根据使用需要,在各项数据的输入,输出及传输过程中,可以满足各种精度的需求。
如:
根据关键字精度的不同,查找可分为精确查找和泛型查找,精确查找可精确匹配读者已知道的书目,泛型查找,只要满足与输入的关键字相匹配的书目即输出,可供读者查找。
3.2.2时间特性要求
在软件方面,响应时间,更新处理时间都比较快且迅速,完全满足用户要求。
a.响应时间:
不超过10秒
b.更新处理时间:
不超过3秒
c.数据的转换和传送时间:
几乎为0
d.解题时间:
很快
3.2.3灵活性
本用户需求,如操作方式,运行环境,结果精度,数据结构于其他软件接口等发生变化时,设计的软件要做适当调整,灵活性非常大。
3.3输人输出要求
查询书目:
输入关键字为书名,作者,索引号,按照精确匹配为主,再索引关联字。
输出时列出索引到的所有书目信息,具体信息包括内容摘要、目录号、作者信息、书名、价格、流水号、购买日期等。
方便读者查找。
借阅图书:
通过设备识别图书和读者(借阅证)的流水号(条形码),向数据库传送信息,然后在数据库索引图书信息和读者信息是否符合要求,符合要求待图书管理员确认后再更新相关数据,并将这些数据存入借书文件,最后输出显示存储成功;否则报错。
查看读者的借阅信息:
进入读者借书信息管理系统,只需要输入读者个人信息即可,然后系统根据输入的信息,送图书馆管理系统索引查找相关信息,最后将读者借书的信息输出显示。
3.4数据管理能力要求
定时整理数据:
系统管理员根据市场图书行情定时整理系统数据库,对图书的借阅情况、读者的管理情况、书库的增减等均可有计算机执行,并将运行结果归档。
查询库存量:
能随时查询书库中图书的库存量,以便准确、及时、方便地为读者提供借阅信息,但不能修改数据,无信息处理权,即可以打印清单、浏览数据等,管理权限由系统管理员掌握和分配。
3.5故障处理要求
a.内部故障处理
在开发阶段可以随即修改数据库里的相应内容。
b.外部故障处理
对编辑的程序进行重装载时,第一次装载认为错,修改。
第二次运行,在需求调用时出错,有错误提示,重试。
c.本软件可能产生的错误为数据库的错误信息,应由数据库管理员对数据库进行维护。
为了确保系统恢复的能力,数据库管理员要定期对数据库进行备份。
3.6其他专门要求
如用数据的安全性、完整性要求:
图书馆各项数据信息必须保证安全性和完整性。
网络系统设有通信、程序、网络三级权限和口令管理,确保系统安全。
4运行环境规定
4.1设备
列出运行该软件所需要的硬设备,说明其中的新型设备及其专门功能,包括:
1)处理器型号及内存容量:
P1及以上,内存大于32M;
2)外存容量,联机或脱机,媒体及其存储格式,设备的型号及数量:
10G,联机;
3)输入与输出设备的型号和数量:
联机或脱机均可;
4)数据通信设备的型号和数量:
服务器Server;
5)功能键及其他专用硬件:
快捷键,鼠标,键盘,可使用触摸屏。
4.2支持软件
1)服务器端软件选择
操作系统:
WindowsXP
数据库管理系统:
SQLServer2000
开发工具:
VisualC++
2)客户端软件选择:
Web浏览器
4.3接口
用户接口为用户界面,通过系统提示用户可自行操作;外部接口可为鼠标、键盘、触摸屏等交互工具;内部接口为学生的学号、图书编号的一致性。
4.4控制
本系统通过网络提供服务,用户通过浏览器访问服务器,向服务器发出服务请求。
因此,需要使用TCP/IP网络协议,做为标准的通信控制接口。
3.2项目开发实例
项目开发计划
1引言
1.1编写目的
本项目开发计划用于从总体上指导图书馆管理系统项目顺利进行并最终得到通过评审的项目产品.
本项目开发计划面向项目组全体成员。
1.2背景
本项目作为《软件文档写作》课程的训练项目的提出,可使我们了解软件文档的相关标准和编写原则,训练并掌握软件各类文档写作的技巧。
假设由于老的操作程序已经不适应了,辽宁工业大学图书馆为了更好的服务同学,提高业务能力,提出了新的系统要求。
他们的新系统要求一套实时,高效,便捷,完善,安全性好的图书管理软件系统。
应图书馆邀请,我小组招标,中标进行开发。
项目软件名称:
图书管理系统。
项目任务提出者:
辽宁工业大学图书馆。
项目开发者:
孙庆贺,麻志鹏,刘旭升,孟翔。
用户:
辽宁工业大学图书馆。
实现软件单位:
学校。
项目与其他软件,系统的关系:
开发的系统要求界面友好,方便直观。
既要方便管理员对图书信息进行添加、删除、修改、查询和统计等管理,又要方便学生借书、还书和续借等业务的办理。
将数据库发布到互联网上,进行资源共享,方便学生可以在自己的权限内对图书信息进行访问,查询相关信息和进行续借操作。
1.3定义
1)Socket:
套接字
2)TCP/IP:
传输控制协议/网络协议
3)I/O:
流输入输出
4)C/S:
客户端/服务器
5)OS:
操作系统
6)Serialize:
序列化
7)Deserialize:
反序列化
8)Lib:
图书管理系统。
1.4参考资料
(1)钱乐秋等,《软件工程》,清华大学出版社;
(2)张害藩,《软件工程导论》(第四版),清华大学出版社;
(3)王珊等,《数据库原理及设计》,清华大学出版社;
(4)赵池龙等,《软件工程实践教程》,电子工业出版社。
2项目概述
2.1工作内容
本项目开发过程中需要进行的主要工作为:
计划编写,需求提取与分析,分析设计。
各工作小组根据时间先后安排,分别对项目进行开发:
各项主要工作:
需求分析小组对学校图书馆进行调研。
软件开发小组对调查结果进行分析,拟订实现方案(如程序结构,流程,数据结构等)。
软件编程小组对软件进行集中开发。
软件审核小组对软件进行评定,审核。
2.2主要参加人员
组长:
孙庆贺(项目经理、主程序员、技术优秀)
组员:
麻志鹏(技术经理、后备工程师、技术良好)
刘旭升(程序员、技术良好)
孟翔(程序员、技术良好)
在项目开发中,各有特长,担任不同角色,发挥了必不可缺的作用。
2.3产品
2.3.1程序
程序名称:
图书管理系统
使用语言:
C,C++;存储形式:
磁盘,磁带,磁鼓
2.3.2文件
1.LibV1.0
2.《用户使用说明书》
2.3.3服务
计划提供以下服务
课堂培训:
以讲课形式对客户进行培训,使其能够正确使用软件。
免费咨询:
客户可以在工作时间向技术人员提出问题并获得解答。
技术支持:
对于某些客户,采取上门指导的方式。
软件维护:
获取软件使用中的问题,提供补丁程序。
软件升级:
对于注册用户,只需较少的费用即可升级到新的版本。
2.3.4非移交的产品
1.源代码
2.技术文档
2.4验收标准
验收标准:
经用户和开发小组负责人双方签字确认的“需求规格说明书”。
重点确认软件的可靠性、易使用性和功能完整性。
1)代码的验收
最后在交付客户之前进行小组内评审
代码编写符合HB6465标准,与文档说明保持一致,代码书写风格统一,采用标准规范。
没有下列错误:
由于软件缺陷造成丢失数据,不符合设计要求,响应时间太长无法接受等问题。
2)文档验收
最后在交付客户之前进行小组内评审
文档格式符合HB6465标准,功能符合与客户的合同要求,清晰易读,有语病与歧义。
3)服务验收
服务硬件达到文档说明的要求,员技术考核合格,定期上门维护。
2.5完成项目的最迟期限
最迟交付日期:
2010年12月4日。
2.6本计划的批准者和批准日期
批准者:
老师;批准日期:
2010年11月24日。
3实施计划
3.1工作任务的分解与人员分工
表3.2工作任务分解与人员分工
任务
姓名
参加时间
软件需求说明书
孙庆贺
全部
项目开发计划
孙庆贺
全部
概要设计说明书
麻志鹏
全部
用户手册
麻志鹏
全部
数据库设计
刘旭升
全部
操作手册
刘旭升
全部
详细设计说明书
孟翔
全部
测试分析报告
孟翔
部分
3.2接口人员
主管部门的接口人员:
由孙庆贺(PM)负责
技术部门的接口人员:
由麻志鹏(分析设计组组长),刘旭升(测试组组长)孟翔(UI组组长)负责
3.3进度
项目启动时间:
2010-11-24
项目交付时间:
20010-12-2
进度:
包括可行性分析、需求分析、软件概要设计、软件详细设计、编码、测试、安装、转换、确认、培训等阶段活动和任务的进度安排,具体安排见“PERT网络图”和“进度计划表”由于网络图太大,难以打印,所以没有在这里列出。
表3.3“图书管理系统”进度计划表
活动编号
活动任务
名称
开始时间
结束时间
持续时间(天)
负责人
参加人员
A
可行性分析
2010.11.21
2010.11.22
1
孙庆贺
全部组员
B
需求分析
2010.11.23
2010.11.24
1
孙庆贺
全部组员
C
软件设计
2010.11.25
2010.11.26
1
孙庆贺
全部组员
D
数据库建立
2010.11.27
2010.11.29
2
刘旭升
全部组员
E
子系统1编码、测试
2010.11.27
2010.11.29
2
刘旭升
全部组员
F
子系统2编码、测试
2010.11.27
2010.11.29
2
刘旭升
全部组员
H
子系统3编码、测试
2010.11.27
2010.11.29
2
麻志鹏
全部组员
I
子系统4编码、测试
2010.11.27
2010.11.29
2
麻志鹏
全部组员
K
硬件安装
2010.11.30
2010.12.1
2
麻志鹏
全部组员
L
硬件测试
2010.12.2
2010.12.4
2
孟翔
全部组员
M
集成测试
2010.12.2
2010.12.4
2
孟翔
全部组员
N
系统安装/培训
2010.12.6
2010.12.10
5
孟翔
全部组员
O
验收测试
2010.12.10
2010.12.20
10
孟翔
全部组员
(注:
持续时间为扣除节假日后的时间工作时间)
3.4预算
参加人员:
4人;开发时间:
2周;费用:
10万元人民币;经费来源:
学校图书馆。
3.5关键问题
参与人员的团结精神以及积极的态度和系统分析设计实现的技术能力。
影响本计划完成的主要问题有:
1)没有经费和硬件设施有限.
2)用户需求不清,存在误解及二义性.
3)第一次开发软件,开发人员没有实际经验.
4)时间有限,没有足够的开发时间.
4支持条件
4.1计算机系统支持
本软件的开发需要工作平台。
一硬件环境:
服务器
(1)处理器(CPU):
Pentium900M(推荐Pentium41.2G
(2)内存容量(RAM):
至少256M(推荐512M)
客户端
(1)处理器(CPU):
Pentium133M或更高
(2)内存容量(RAM):
64M或更高
二软件环境
数据库服务器端
(1)操作系统:
Microsoft
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件文档写作 图书管理系统 软件 文档 写作 图书 管理 系统