软件文档写作实训报告(刘旭生)图书馆管理.doc

软件文档写作实训报告(刘旭生)图书馆管理.doc

《软件文档写作实训报告(刘旭生)图书馆管理.doc》由会员分享，可在线阅读，更多相关《软件文档写作实训报告(刘旭生)图书馆管理.doc（24页珍藏版）》请在冰豆网上搜索。

辽宁工业大学

软件文档写作实训报告

题目：

图书馆管理系统软件文档

院（系）:

软件学院

专业班级：

软件技术081班

学号：

081404005

学生姓名：

安凯辰

指导教师：

王彦华

教师职称：

助教

起止时间：

2010.11.22-2010.12.6

实训任务及评语

院（系）：

软件学院教研室：

软件教研室

学号

081404005

学生姓名

安凯辰

专业班级

软件技术081

实训题目

图书馆管理理系统软件文档

实训任务

实训任务及要求：

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.2软件文档的主要内容 4

第3章 实例 5

3.1数据库实例 5

3.2详细设计实例 11

第4章 实训日记 19

第5章 实训总结 20

第1章实训目的与要求

1.1实训目的

本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。

1、了解软件开发周期各阶段的文档。

2、掌握各文档阐述的内容及作用。

3、了解文档所采用的国际、国家等相关标准。

4、了解各文档所涉及的软件知识。

5、掌握各文档采用的描述工具。

6、具体编写出2个主要的软件文件。

1.2实训的实验环境

学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。

1.3实训的预备知识

要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。

该实训应安排在毕业设计之前进行。

1.4实训要求

实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。

正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。

第2章软件文档及其组成

2.1软件文档的作用及分类

软件文档（document）也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。

它和计算机程序共同构成了能完成特定功能的计算机软件（有人把源程序也当作文档的一部分）。

我们知道，硬件产品和产品资料在整个过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。

没有文档的软件，不成其为软件，更谈不到软件产品。

软件文档的编制（documentation）在软件开发工作中占有突出的地位和相当的工作量。

高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。

然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。

软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。

从用户方面看，他们又常常抱怨：

文档售价太高、文档不够完整、文档编写的不好、文档已经陈旧或是文档太多，难于使用等等。

计算机

用户

软件开发人员

维护人员

软件开发管理人员

图2-1桥梁作用图

文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图中看出。

软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。

软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。

管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。

软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。

以上三种文档构成了软件文档的主要部分。

我们把这三种文档所包括的内容列在图中。

2.2软件文档所采用的标准

文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

　　 可行性分析报告：

说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

　　 项目开发计划：

为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

　　 软件需求说明书（软件规格说明书）：

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

　　 概要设计说明书：

该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。

　　 详细设计说明书：

着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

　　 用户操作手册：

本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

　　 测试计划：

为做好集成测试和验收测试，需为如何组织测试制订实施计划。

计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

　　 测试分析报告：

测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

　　 开发进度月报：

该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

　　 项目开发总结报告：

软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。

　　 软件维护手册：

主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。

　　 软件问题报告：

指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

　　 软件修改报告：

软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

2.2软件文档的主要内容

教师可为学生推荐若干个题目，也可以由学生自己提出题目，经教师审定后确定题目。

题目应尽量选取学生较熟悉的题目或业务功能较简单的题目，以减少业务调研和需求分析的时间。

实践形式：

多人合作、分散进行。

第3章实例

3.1数据库实例

3.1数据库设计和概要设计

设计数据库系统时应该首先充分了解用户各个方面的需求，包括现有的以及将来可能增加的需求。

数据库设计包括如下步骤：

数据库需要分析。

数据库概念结构设计。

数据库逻辑结构设计。

（一）.数据库需求分析

用户的需求具体体现在各种信息的提供、保存、更新和查询，这就要求数据库结构能充分满足各种信息的输入和输出。

收集基本数据、数据结构以及数据流程，组成一份详尽的数据字典，为后面的具体设计打下基础。

仔细分析调查有关图书馆管理信息需求的基础上，将得到如图二所示的本系统所处理的数据流程。

书籍类别设置

读者种类设置

基本信息录入

基本信息录入

读者种类信息管理

书籍类别信息管理

读者登记

书籍登记

基本信息录入

基本信息录入

读者信息管理

书籍信息管理

基本信息录入

基本信息录入

基本信息录入

借阅信息管理

图3-1图书馆管理数据流图

针对一般图书馆管理信息系统的需求，通过对图书馆管理工作过程的内容和数据流程分析，设计如下所示的数据项和数据结构：

读者种类信息，包括的数据项有：

种类编号、种类名称、借书数量、借书期限、有效期限、备注等。

读者信息，包括的数据项有：

读者编号、读者姓名、读者种类、读者性别、工作单位、家庭住址、电话号码、电子邮箱地址、办证日期、备注等。

书籍类别信息，包括的数据项有：

类别编号、类别名称、关键词、备注信息等。

书籍信息，包括的数据项有：

书籍编号、书籍名称、书籍类别、作者姓名、出版社名称、出版日期、书籍页数、关键词、登记日期、备注信息等。

借阅信息，包括的数据项有：

借阅信息编号、读者编号、读者姓名、书籍编号、书籍名称、借书日期、还书日期、备注信息等。

（二）.数据库概念结构设计

得到上面的数据项和数据结构以后，就可以设计出能够满足用户需求的各种实体，以及它们之间的关系，为后面的逻辑结构设计打下基础。

设计规划出的实体有：

读者类别信息实体、读者信息实体、书籍类别信息实体、书籍信息实体、借阅信息实体、借阅信息实体。

各个实体具体的描述E-R图如下。

读者类别信息实体E-R图如图三.

读者类别信息实体

借书数量

种类编号

种类名称

借书期限

..

图3-2读者信息实体E-R图

读者信息实体

办证日期

读者编号

读者类别

读者姓名

.

图3-3书籍类别实体E-R图

书籍类别信息实体

备注信息

类别编号

类别名称

关键词

.

图3-4书籍信息实体E-R图

书籍信息实体

出版社

书籍编号

书籍名称

书籍类别

.

图3-5借阅信息实体E-R图

借阅