软件文档写作实训 17.docx

1、软件文档写作实训 17辽 宁 工 业 大 学 软件文档写作 实训报告题目： 图书馆管理系统软件文档 院（系）: 软件学院 专业班级： 起止时间： 2012.11.26-2012.12.02 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号实训题目图书馆管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录

2、实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日目 录第1章 实训目的与要求 11.1 实训目的 11.2 实训的实验环境 11.3 实训的预备知识 11.4 实训要求 1第2章 软件文档及其组成 22.1软件文档的作用及分类 22.2软件文档所采用的标准 32.3 软件文档的主要内容 4第3章 实 例 53.1图书馆管理系统数据库设计说明书实例 53.2 图书馆管理系统操作手册设计说明书实例 9第4章 实训日记 14第5章 实

3、训总结 15参考文献 16第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实

4、训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章 软件文档及其组成2.1软件文档的作用及分类一、软件文档的作用 软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制

5、(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间起着多种桥梁的作用。二、文档的分类 软件文档从形式上来看，大致可分为两类： 一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系

6、统中产生，但它必须是可阅读的。 按照文档产生和使用的范围，软件文档大致可分为三类： 1.开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2.管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3.用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的

7、资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。 三、软件文档的工作 国家标准局在1988年1月发布了计算机软件开发规范和软件产晶开发文件编制指南，作为软件开发人员工作的准则和规程。它们基于软件生存期方法，把软件产品从形成概念开始，经过开发、使用和不断增补修订，直到最后被淘汰的整个过程应提交的文档归于以下十三种。下面对其中每一个文档做一些简要的说明： 1.可行性研究报告：说明该软件项目的实现在技术上、经济上和社会因素上的可行性，评述为合理地达到开发目标可供选择的各种可能的实现方案，说明并论证所选定实施方案的理由。 2.项目开发计划：为软件项目实施方案制定出的具体计划。它应包括各部分

8、工作的负责人员、开发的进度、开发经费的概算、所需的硬件和软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的基础。 3.软件需求说明书：也称软件规格说明书。其中对所开发软件的功能、性能、用户界面机运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 4.数据要求说明书：该说明书应当给出数据逻辑描述和数据采集的各项要求，为生成和维护系统的数据文件做好准备。 5.概要设计说明书：该说明书是概要设计工作阶段的成果。它应当说明系统的功能分配、模块划分、程序的总体结构、输入输出及接口设计、运行设计、数据结构设计和出错处理设计等，为详细

9、设计奠定基础。 6.详细设计说明书：着重描述每一个模块是如何实现的，包括实现算法、逻辑流程等。 7.用户手册：详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。2.2软件文档所采用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。一、按标准的类型划分按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准

10、则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。二、按标准的范围划分按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。产品工程功能包括定义、生产和支持最

11、终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.3 软件文档的主要内容我所做的软件文档是图书馆管理系统详细设计说明书、图书馆综合管理系统数据库设计说明书、图书馆综合管理系统操作手册。本图书馆管理系统分为以下八大模块：登录、读者管理、读者留言、图书管理、关于我们、借阅管理、常用工具、退出，各模块的基本功能如下：登录模块：此模块对登录者的身份进行了限制，分为读者登录和管理员登录，登录时需输入账号和密码。读者管理模块包括：读者查询、增加读者、删除读者、修改读者四个子模块，

12、是对读者借书情况及个人信息的综合管理模块。读者留言模块：此模块没有子模块，其作用为方便读者留言进而与管理员更好的交流。图书管理模块包括：图书查询、增加图书、删除图书、修改图书四个子模块，是对图书借留情况及图书基本情况的综合管理模块。关于我们模块：此模块也没有子模块，是对图书馆的一些相关规定及规章的概括总结，方便读者更好的了解此图书馆。借阅管理模块包括：借书、还书、罚款信息三个子模块，是图书馆借阅规章体制的具体执行模块，可对图书馆图书进行借阅和归还等操作，及处罚规定。常用工具模块包括：万年历、记事本、在线咨询等三个子模块，其中在线咨询又包括以读者或管理员身份登录两种登录方式。此模块设计的初衷是为

13、了方便读者进行时间及日期的查询，及记录一些事宜，并在线与管理员或读者进行交流。退出模块：是为了读者或管理员能安全的退出此程序。 第3章 实 例3.1图书馆管理系统数据库设计说明书实例图书馆管理系统数据库设计说明书（GB856788）1引言1.1编写目的数据库是整个系统的基石,数据库的设计优劣直接影响到整个系统的设计成败,因而数据库设计主要目的是根据分析和概要设计中发现的对象和类，确定哪些对象需要持久保存，然后将对象属性及对象间关系转化成关系表。一切工作都要按照一定的顺序或计划来执行，设计数据库设计说明书的目的就是为了让工作人员有一定的规律及计划来完成数据库的最初理论模型，以便于在实践中进行操作

14、。这份数据库设计说明书的完成是为了让工作人员阅读，方便工作，同时也可给要求开发此系统的单位提供一份书面形式的数据库的文档，方便提供意见或要求，及时进行修改。2 外部设计2.1标识符和状态1.实现删除图书的接口设计说明：该方法是对ActionListener接口进行进一步实现的，用来体现图书管理模块中删除图书子模块的监视器及连接数据库的实现方法代码。public void actionPerformed(ActionEvent e)Connection con; /分配一个Connection对象PreparedStatement sql,sql1; /分配Statement对象 try Cla

15、ss.forName(sun.jdbc.odbc.JdbcOdbcDriver); /加载驱动器 catch(ClassNotFoundException f) trycon=DriverManager.getConnection(jdbc:odbc:tushuguan); /连接数据库 JOptionPane.showMessageDialog(this,图书编号不能为空！,提示对话框,JOptionPane.WARNING_MESSAGE);con.close(); /关闭连接 catch(SQLException e2)System.out.println(e2);3 结构设计 3.1概

16、念结构设计概念设计阶段的主要任务是在需求分析的基础上画出整个系统的E-R图，该图是人们将现实世界的客观对象抽象为某一种不依赖于计算机系统和某一个DBMS的信息结构，即概念模型，然后再把概念模型转换为计算机上的某一DBMS支持的数据模型。它脱离了现实世界，是信息世界的一个产物。E-R图为实体-联系图，提供了表示实体型、属性和联系的方法，用来描述现实世界的概念模型。构成E-R图的基本要素是实体型、属性和联系。经过对系统需求分析等因素的分析，最后得到的本图书馆管理系统的E-R图。图3.1 E-R图3.2逻辑结构设计数据库逻辑结构的设计分为两个步骤：1.将概念设计所得的E-R图转换为关系模型关系模型的

17、逻辑结构是一组关系模式的集合。E-R图则是由实体、实体的属性和实体之间的联系三个要素组成的。所以将E-R图转换为关系模型实际上就是要将实体、实体的属性和实体之间的联系转换为关系模式，这种转换一般遵循如下原则：一个实体型转换为一个关系模式。实体的属性就是关系的属性，实体的码就是关系的码。一个1：1联系可以转换为一个独立的关系模式，也可以与任意一端对应的关系模式合并。如果转换为一个独立的关系模式，则与该联系相连的各实体的码以及联系本身的属性均转换为关系的属性，每个实体的码均是该关系的候选码。如果与某一端实体对应的关系模式合并，则需要在该关系模式的属性中加入另一个关系模式的码和联系本身的属性。一个1

18、：n联系可以转换为一个独立的关系模式，也可以与n端对应的关系模式合并。如果转换为一个独立的关系模式，则与该联系相连的各实体的码以及联系本身的属性均转换为关系的属性，而关系的码为n端实体的码。一个m：n联系转换为一个关系模式。与该联系相连的各实体的码以及联系本身的属性均转换为关系的属性，而关系的码为各实体码的组合。概念模型转换为关系模型的结果并不唯一，为了进一步提高数据库应用系统的性能，还应对关系模型进行适当的修改和调整，这就是数据模型的规范化，该规范化主要确定出每个关系模式内部属性之间的数据依赖和不同关系之间的数据依赖。关系模型的规范化理论是以分析属性间的函数依赖为基础，通过对关系模型的分解，

19、逐步消除各处异常，减少数据的冗余2.对关系模型进行优化本系统选择的DBMS是关系型数据库管理系统。因此只需将E-R 图中的每一个实体和联系都转换成关系模式中的一个关系即可，并将关系模式进行规范化。举例如下：图书馆管理系统，其E-R图对应的关系数据模型部分结构如下： 图书(ISBN, bid, worker, bname, printor, bdate, jiage, zhuangtai)读者(rid, rname, pass, leixing, sex, num, yijie)管理员(gid, gname, gpass)借书(bid, rid, Bdate, Rdate)罚款(bid, rid

20、, Now, Pmoney)还书(bid, rid, Rdate)3.3物理结构设计根据需求分析及各项功能的分析，进行集中、分块的设计，按照结构化程序设计的要求，得到他们的物理位置：主数据文件的存储位置为：C:Program FilesMicrosoft SQL ServerMSSQLDataCYGLXT_Data.MDF事务日志文件的存储位置为：C:Program FilesMicrosoft SQL ServerMSSQLDataCYGLXT_Log.LDF具体实现的部分物理结构设计为：表3.1 book表序号列名数据类型长度允许空主键1ISBNchar20是否2bidchar20否是3w

21、orkerchar20是否4bnamechar20是否5printorchar20是否6bdatechar20是否7jiagechar20是否8zhuangtaichar20是否4 运用设计4.1数据字典设计数据字典是一个预留空间，一个数据库，这是用来储存信息数据库本身。 数据字典可能包含的信息，例如： 数据库设计资料、储存的SQL程序、用户权限、用户统计、 数据库的过程中的信息、数据库增长统计、数据库性能统计，数据字典则是系统中各类数据描述的集合,是进行详细的数据收集和数据分析所获得的主要成果。数据字典通常包括数据项、数据结构、数据流、数据存储和处理过程五个部分。数据字典是关于数据的信息的集

22、合，也就是对数据流图中包含的所有元素的定义的集合。数据字典最重要的作用是作为分析阶段的工具。任何字典最重要的用途都是供人查询对不了解的条目的解释，在结构化分析中，数据字典的作用是给数据流图上每个成分加以定义和说明。换句话说，数据流图上所有的成分的定义和解释的文字集合就是数据字典，而且在数据字典中建立的一组严密一致的定义很有助于改进分析员和用户的通信。如下是本图书馆管理系统的数据字典：表3.2 book字典字段中文名称字段名类型长度说明书号ISBNchar20全书统一编号，可做书的唯一标识本书编号bidchar20书的编号作者名workerchar20书的作者书名bnamechar20书名出版社

23、printorchar20出版社名出版日期bdatechar20书的出版日期价格jiagechar20书的现价状态zhuangtaichar20书的借出状态4.2安全保密设计安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。本系统部分采用最高级别的权限控制，采用基于数据库的安全认证，系统自带一个用户管理模块，可以方便的创建用户和授权。最初登录时，将看到以管理员和读者两种身份登录的选择，这样如果选择以读者身份登录，进入系统后，将有很多功能受限，不能使用。而如果以管理员身份登录，则所有功能都可使用。3.2 图

24、书馆管理系统操作手册设计说明书实例图书馆管理系统操作手册设计说明书（GB856788）1 引言1.1编写目的此份操作手册是面向于使用本图书管理系统的用户及管理员，本手册会详尽的说明本系统的功能及使用，通过阅读本手册，用户及管理人员会对本系统有一个整体全面的认识，从而学会该如何进行操作。2 软件征述2.1软件的结构表3.3 总体结构图表名称功能输入输出处理读者查询查询读者借阅情况读者编号读者姓名、已借图书、借阅时间、归还时间增加读者读者注册账号读者姓名、读者编号、读者密码、读者性别、读者类型、限借数量注册成功存入后台数据库中删除读者删除读者账号读者编号删除成功数据库表中不再存在此账号修改读者修改

25、读者信息读者编号后再进一步修改数据修改成功改变数据库表中的数据图书查询进行图书查询图书ISBN号或图书名或全部图书图书编号、ISBN号、图书作者、图书名称、出版社、出版日期、价格、状态增加图书增加图书图书编号、ISBN号、图书作者、图书名称、出版社、出版日期、图书价格增加成功存入后台数据库中删除图书删除数据库中的图书图书编号删除成功在数据库中删除修改图书修改数据库中图书内容先输入图书编号修改成功数据库中表中内容已修改在线咨询留言读者编号留言成功借书借阅图书图书编号、读者编号借阅成功还书归还图书图书编号、读者编号归还成功罚款信息计算罚款钱数读者编号罚款金额等转存入后台数据库 续表3.3 名称功能

26、输入输出处理万年历显示当前时间可进行选择记事本保存日志、删除日志文字保存查看信息查阅图书馆信息3 安装与初始化(1)运行环境设置本实例是在Windows 2000下开发的，程序测试环境为Windows 2000和Windows XP。用户在Windows 2000和Windows XP下都可使用本实例。(2)源程序使用方法如果用户要使用源程序，计算机除了满足上面要求的配置外，还需要完成如下工作。在系统中安装Eclipse 3.0版以及多国语言包和JDK安装环境如果后台数据库为SQL Server 2000，请在系统上安装SQL Server2000。关于数据库方面的说明参见下一节。(3)使用数

27、据库SQL Server2000将实例目录“library1”文件夹下扩展名为“.MDF”和“.LDF”的两个文件拷贝SQL Server2000安装路径下的“MSSQL”/“Data”目录下。打开SQL Server 2000中的“企业管理器”，然后展开本地服务器，在“数据库”数据项上单击鼠标右键，在弹出的快捷菜单中选择“所有任务”/“附加数据库”菜单项。将弹出“附加数据库”对话框 在该对话框中单击“”按钮选择所要附加数据库的.mdf文件的路径，例：附加图书馆管理系统的数据库可以选择 “C:sqlMSSQLDatalibrary1_Data.MDF”，如图3所示。单击【确定】按钮，即可完成数

28、据库的附加操作。(4)配置数据源打开 “控制面板”/“管理工具”，中启动“ODBC数据源管理器”管理程序单击“用户DSN”或“系统DSN”，然后，单击“添加”按钮，开始添加一个新的数据源在驱动程序列表中选择“SQL Server”驱动程序，建立一个访问SQL Server数据库服务器的连接。单击“完成”按钮系统将显示“建立新的数据源到SQL Server”向导对话框在“名称”输入框中输入新数据源的名称,在“说明”中输入对该数据源的说明。再在“服务器”下拉框中选择需要连接的SQL Server数据库服务器名称。单击“下一步”按钮，选择“连接SQL Server以获取其他选项的默认配置”复选框，将

29、会在进入下一步操作前使用选项下方输人框中输入的用户名和密码，并连接到SQL Server服务器。单击“下一步”按钮选择“更改默认的数据库为”复选框，在下方的下拉框中选择当前的连接的SQL Server数据库服务器中的数据库作为默认数据库，这样，连接数据库的客户端应用程序就将选中的这个数据库作为默认的使用数据库。单击“下一步”按钮，在单击“完成”按钮(5)使用Eclipse运行程序打开Eclipse，记住工作空间路径，然后单击“文件”/“新建项目”，选择“java项目”，输入项目名称，单击“完成”寻找工作空间的路径，打开workspace文件夹，有一个以新建的项目名为文件夹名的文件夹，打开，并把

30、自己的Java文件复制粘贴到其中，然后刷新一下在包资源管理器中刷新一下，打开项目，其中有多个包，只要查找缺省包中的“MainFream.Java”,选中它右键，选择“运行方式”/“java运行方法”，主界面就运行出来了。图3.2 运行系统界面4 运行说明4.1运行表运行程序及目的： 读者查询：查询读者借阅情况，运行时的具体程序名为：Search_reader.java图书查询：进行图书查询, 运行时的具体程序名为：Search_book.java借书：借阅图书, 运行时的具体程序名为： Borrow.java还书：归还图书, 运行时的具体程序名为：Return.java留言：读者留言, 运行时的具体程序名为：MessaeBoard.java关于我们：查阅图书馆信息, 运行时的具体程序名为：About.java万年历：日期日历，运行时的具体程序名为：WanNian