软件文档写作实训报告(孟翔)图书管理

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 图书管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术 081班 学 号： 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助 教 起止时间： 2010.11.22-2010.12.05 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号学生姓名安凯辰专业班级软件技术081班实训题目 图书管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章软件文档及其组成22.1软件文档的作用及分类22.2软件文档所采用的标准52.2 软件文档的主要内容6第3章实 例103.1 图书管理系统详细设计实例103.2 图书管理测试分析实例16第4章实训日记20第5章实训总结21第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档。软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。开发文档的作用： (1) 作为软件生存期个阶段之间的通信工具，记录生成软件需求、设计、编码、测试等的详细规定和说明； (2) 描述开发小组的工作职责。通过规定软件规划设计、主题脚本编制、文档编制、质量保证等人员的角色，来定义“如何做”和“何时做”； (3) 用作检验点，而允许管理者评估开发进度。如果开发文档缺失或过时，管理者将失去跟踪和控制软件项目的重要工具； (4) 形成系统维护人员所要求的基本的软件支持文档，并构成产品文档 的一部分； (5) 记录软件开发的历史。可行性研究报告的内容： (1) 陈述开发目的、要求和限制条件，表达可行性研究的前提条件。 (2) 对现有系统的描述，进而阐述系统开发的意义和必要性。 (3) 提出若干新系统的建议方案，并依次进行技术、经济和社会可行性分析 (4) 在比较多个方案的基础上，得出可行性研究的结论 可行性研究报告的要求：软件的开发首先要确切定义用户要求解决的问题，即确定要解决问题的性质、目标和规模。对此，可行性分析人员对所要解决问题的理解是否正确十分关键，因为这决定了开发工作的方向。 (1) 阐明目标软件的基本要求性能输出(如报告、文档或数据，输出项特征，如用途、产生频度、接口及方法对象)输入(包括数据来源、类型、数量、数据的组织以及提供的频度)处理流程和数据流程(用图表表示最基本的部分，并辅之以文字说明)安全和保密方面的要求与本系统相关联的其他系统(2) 说明所建议系统的主要开发目标人力与设备费用的减少处理速度的提高控制精度或生产能力的提高管理信息服务的改进自动决策系统的改进人员利用率的改进(3) 说明在该项开发中给出的条件、假定和所受到的限制所建议系统的运行寿命的最小值进行系统方案选择比较的时间经费、投资方面的来源和限制法律和政策方面的限制硬件、软件、运行环境和开发环境方面的条件和限制可利用的信息和资源系统投入使用的最晚时间(4) 说明进行可行性研究的方法和评价尺度说明该项可行性研究的进行方法，所建议的系统的评价方法。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等说明对系统进行评价时所使用的主要尺度。如费用、各项功能的优先次序、开发时间的长短及使用中的难易程度等(5) 对现有系统的分析现有系统是新系统将来的取代对象，也是新系统的参照对象。对现有系统的分析是为了阐明开发新系统的必要性，同时，也是导出新系统的方案的出发点用户文档用户文档主要负责对软件产品的安装、配置、使用、维护等信息进行描述。包括系统安装配置手册、用户操作手册、软件需求说明书、数据要求说明书等。用户文档的作用 (1) 为使用和运行软件产品的用户提供培训和运行参考信息； (2) 为产品维护工程师提供必要的信息； (3) 促进和方便软件产品的市场推广。管理文档 管理文档主要是对软件开发过程的管理信息进行描述。管理文档除了前面列表内容，还应该包括被管理者的反馈信息，如各色表格、工作总结、开发体会、产品建议等。软件测试计划文档测试计划起到测试工作过程框架结构的功能，是好的测试工作的基础。一个测试计划的基本内容包括：基本情况分析、测试需求说明、测试策略和记录、测试资源配置、问题跟踪报告、测试计划的评审等。基本情况分析。包括系统运行平台、应用领域、特点和主要功能模块等。分析要点有：测试目的和侧重点、系统适合于测试的内容/操作划分、测试的潜在风险、系统与测试相关的资料说明。测试需求说明。列出测试功能项，规定应该测试的具体内容。测试策略和记录。描述如何开展测试，规定测试记录的内容。必要时，应给出测试记录文档的模板。测试资源配置。针对测试项目的每一个阶段任务，列出所需要的资源，可能的话，给出可能更新需要的空间。问题跟踪报告。报告包括问题的发行者和修改者、问题发生的频率、发现问题的测试用例，以及明确问题产生时的测试环境。问题描述应尽可能是定量、分门别类的列举。问题分为：严重问题、一般问题、建议问题。2.2软件文档所采用的标准CIMS是英文Computer Integrated Manufacturing Systems或contemporary的缩写，直译就是计算机/现代集成制造系统。计算机集成制造-CIM的概念最早是由美国学者哈林顿博士提出的，其基本出发点是： 1）企业的各种生产经营活动是不可分割的，要统一考虑； 2）整个生产制造过程实质上是信息的采集、传递和加工处理的过程。 CIMS 定义：CIMS是通过计算机硬软件。并综合运用现代管理技术、制造技术、信息技术、自动化技术、系统工程技术。将企业生产全部过程中有关的人、技术、经营管理三要素及其信息与物流有机集成并优化运行的复杂的大系统。现代集成制造系统（Contemporary Integrated Manufacturing System）。将信息技术、现代管理技术和制造技术相结合，并应用于企业全生命周期各个阶段，通过信息集成，过程优化及资源优化，实现物流、信息流、价值流的集成和优化运行，达到人（组织及管理）、经营和技术三要素的集成，以加强企业新产品开发的T、Q、C、S、E，从而提高企业的市场应变能力和竞争力。从功能上看，CIMS包括了一个制造企业的设计、制造、经营管理三种主要功能，要使这三者集成起来，还需要一个支撑环境，即分布式数据库和计算机网络以及指导集成运行的系统技术。 1.四个功能分系统 （1）管理信息分系统 （2）产品设计与制造工程设计自动化分系统 （3）制造自动化或柔性制造分系统 （4）质量保证分系统 2.两个支撑分系统 （1）计算机网络分系统 （2) 数据库分系统CIMS集成的内涵集成和连接不同，它不是简单地把两个或多个单元连接在一起，它是将原来没有联系或联系不紧密的单元组成为有一定功能的、紧密联系的新系统。两种或多种功能的集成包含着两种或多种功能之间的相互作用。集成是属于系统工程中的系统综合、系统优化范畴。CIMS的集成，从宏观上看主要是以下5个方面： 1）系统运行环境的集成 2）信息的集成 3）应用功能的集成 4）技术的集成 5）人和组织的集成2.3软件文档的主要内容 读者登记，即输入读者的具体信息。 输入 ：读者具体信息。 处理 ：通过图书管理系统写入读者目录文件中。 输出 ：读者具体信息。 输入新书的全部信息。 输入 ：新书的全部信息。 图书管理系统软件需求分析 处理 ：通过图书管理系统写入图书目录文件中。 输出 ：新书信息的全部内容。 查询读者的相关信息。 输入 ：读者信息的关键字（读者编号或姓名）。 处理 ：利用关键字在读者目录文件中找到此编号或姓名读者的相关信息。 输出 ：读者的相关信息。 查询图书的信息。 输入 ：图书信息的关键字（图书分类号或书名）。 处理 ：利用关键字在图书目录文件中找到此图书分类号或书名图书的相关信息。 输出 ：图书的相关信息。 输入读者借书信息。 输入 ：读者借书信息。 处理 ：通过图书管理系统写入借书文件中。 输出 ：读者借书信息的全部内容 查询读者借书的相关信息。 输入 ：借书信息的关键字（流水号）。 处理 ：利用关键字在借书文件中找到此流水号图书的相关信息。 输出 ：借书相关信息。性能精度需求 在精度需求上，根据使用需要，在各项数据的输入，输出及传输过程中，可以满足各种精度的需求。 时间需求 在软件方面，响应时间，更新处理时间都比较快且迅速，完全满足用户要求。灵活性当用户需求。故障处理 内部故障处理 ：在开发阶段可以随即修改数据库里的相应内容。 外部故障处理 ：对编辑的程序进行重装载时，第一次装载认为错，修改。第二次运行，在需求调用时出错，有错误提示，重试。输人输出项主模块1.输入项目：操作系统传递至的各种消息以及用户的输入数据。2.输出项目：用户界面显示。学生管理模块1.输入项目：与学生管理操作子对话框有关的用户输入及系统消息。2.输出项目：操作结果显示。图书管理模块1.输入项目：用户口令。2.输出项目：相应的界面。借阅管理模块1.输入项目：学生学号、图书编号。2.输出项目：学生信息、相关借书信息。归还管理模块1.输入项目：图书编号。2.输出项目：相关学生信息。流程逻辑登陆模块人机界面设计:系统响应时间：学生或管理人员登陆的响应时间应稳定在1s左右；出错信息处理：若学生或管理人员输入的帐号和密码不匹配或输入不存在的帐号，系统应友好进行提示，如提示you are not a system user ！”学生登记程序描述：实现学生信息登记功能输入项：字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期输出项：字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期算法：学生登记的程序设计流程图如下学生查询程序描述：实现学生信息查询功能输入项：用字符串表示的汉字，字符串最大长度是10；整数类型的数字，最长不超过6输出项：用字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期算法：学生查询的程序设计流程图图书登记程序描述 实现图书登记的功能输入项：用字符串表示的汉字或英文，字符串最大长度是20；数值型的数字输出项：用字符串表示的汉字或英文，字符串最大长度是20；数值型的数字算法：实现图书登记的程序设计的流程图 实现查书功能。输入项：用字符串表示的汉字或英文，字符串的最大长度为40个字符。输入方式为标准输入。输出项：用字符串表示的汉字或英文，字符串的最大长度为40个字符。输出方式为标准输出。算法接口外部接口按Windows应用软件用户界面的规范来设计，使用以对话框为主的用户界面，便于用户使用。内部接口模块间接口采用数据耦合方式，通过参数表传送数据，交换信息。用户接口本产品的用户一般需要通过终端进行操作，进入主界面后点击相应的窗口，分别进入相对应的界面(如：输入界面、输出界面)。用户对程序的维护，最好要有备份。限制条件技术约束 ：本项目的设计是在汉语程序设计语言的条件下进行的，技术设计采用软硬一体化的设计方法。 环境约束 ：运行该软件所适用的具体设备必须是奔腾133、内存16兆以上的计算机;标准约束 ：该软件的开发完全按照企业标准开发，包括硬件、软件和文档规格硬件限制 奔腾133 、内存16兆以上PC机满足输入端条件。第3章 实 例3.1 图书管理系统详细设计实例详细设计说明书1引言1.1编写目的 图书管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。1.2背景 本项目的名称：图书管理系统开发软件。 本项目的任务提出者及开发者是图书管理系统软件开发小组,用户是学校图书。 本产品是针对电脑管理图书的需求设计的，可以完成读者登记、读者借还书、图书登记、图书查询等主要功能。1.3定义Mysql：数据库管理软件 DBMS：数据库管理系统Windows 2000/2003/XP：运行环境 JSP ：软件开发语言Myeclipse ：开发工具1.4参考资料软件工程导论第5版 张海藩编著 清华大学出版社实用软件工程 Leszek A.Maciaszek Bruc Lee Liong著2程序系统的结构3程序1（用户登陆）设计说明3.1程序描述系统由3大模块，6小模块组成：序号 编号 名称1 01 登陆模块2 02 管理模块3 031 图书信息查询模块4 032 学生信息查询模块5 021 入库管理模块6 022 学生借书模块7 023 学生还书模块8 024 图书注销模块9 040 基础信息设置3.2功能功能类型：查询数据功能描述：提高系统的安全性前提业务：无后继业务：02 （管理模块）功能约束：权限约束约束描述：操作权限：图书管理员3.3性能精度需求 在精度需求上，根据使用需要，在各项数据的输入，输出及传输过程中，可以满足各种精度的需求。 时间需求 在软件方面，响应时间，更新处理时间都比较快且迅速，完全满足用户要求。 灵活性 当用户需求，如操作方式，运行环境，结果精度，数据结构于其他软件接口等发生变化时，设计的软件要做适当调整,灵活性非常大。 故障处理 a. 内部故障处理 在开发阶段可以随即修改数据库里的相应内容。 b. 外部故障处理 对编辑的程序进行重装载时，第一次装载认为错，修改。第二次运行，在需求调用时出错，有错误提示，重试。3.4输人项主模块输入项目：操作系统传递至的各种消息以及用户的输入数据。学生管理模块输入项目：与学生管理操作子对话框有关的用户输入及系统消息。图书管理模块输入项目：用户口令。借阅管理模块输入项目：学生学号、图书编号。归还管理模块输入项目：图书编号。3.5输出项主模块输出项目：用户界面显示。学生管理模块输出项目：操作结果显示。图书管理模块输出项目：相应的界面。借阅管理模块输出项目：学生信息、相关借书信息。归还管理模块输出项目：相关学生信息。3.6算法无3.7流程逻辑 登陆模块人机界面设计:系统响应时间：学生或管理人员登陆的响应时间应稳定在1s左右；出错信息处理：若学生或管理人员输入的帐号和密码不匹配或输入不存在的帐号，系统应友好进行提示，如提示you are not a system user ！”过程设计：盒图：输入帐号输入密码判断密码是否正确显示该用户信息，等待继续操作提示错误信息，返回登陆界面判定表：帐号正确密码匹配登陆成功返回登陆界面学生登记a） 程序描述实现学生信息登记功能b） 输入项用字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期c） 输出项用字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期d） 算法学生登记的程序设计流程图如下学生查询a) 程序描述实现学生信息查询功能b) 输入项 用字符串表示的汉字，字符串最大长度是10；整数类型的数字，最长不超过6c） 出项用字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期d） 算法 学生查询的程序设计流程图图书登记a) 程序描述 实现图书登记的功能b) 输入项 用字符串表示的汉字或英文，字符串最大长度是20；数值型的数字c) 输出项 用字符串表示的汉字或英文，字符串最大长度是20；数值型的数字d) 算法实现图书登记的程序设计的流程图3.8接口1用来查询一条数据的私有接口2增加记录的公共接口3删除记录的公共接口4查询记录的公共接口5修改记录的接口3.9存储分配管理员表：（admin）序号字段名类型长度精度小数位数默认值允许空主键说明1(admin_ID)管理员IDInt102(admin_password)管理员密码Char153(admin_quanxian)权限Nvarchar153.10注释设计无3.11限制条件无3.12测试计划功能性测试：黑盒测试3.13尚未解决的问题无3.2 图书管理测试分析实例测试分析报告（GB856788）1引言1.1编写目的检验软件产品中是否存在明显的错误，验证该软件已正确地实现了用户的要求，确立用户对软件质量的信心。为了尽可能的找出软件的不足，提高软件的质量，促进软件的成功验收，专门制定了本大纲。其主要目的在于为所要进行的测试工作制定各种必要的准则和规范，以及在有关方面协议的基础上对测试工作进行合理组织与管理。根据测试计划报告，对软件进行测试，详细记录测试过程，以对软件的质量进行测评，为软件设计人员提供BUG依据，故做产生测试分析报告。1.2背景1.项目名称：辽宁工业大学图书管理系统（Bookmanage）2.项目提出者：常毅3.项目开发者：软件学院网络系统081班第一小组4.用户：大学全体学生、教职工。5.运行中心：辽宁工业大学大学图书6.测试环境及其影响：服务器端安装在计算机中心的一个机柜上，客户端运行在计算机中心的其他机柜上。由于服务器及客户端同时在计算机中心使得测试响应速度方面存在较大误差。1.3定义B/S结构：浏览器/服务器结构，即客户端使用浏览器通过网络访问服务器，向服务器提交服务请求。1.4参考资料1.软件工程导论 张海藩 清华大学出版社2.图书管理系统总体设计说明书3.软件需求规格说明书2测试概要标识符功能模块名称是否测试是否通过测试日志单元1 登录系统用户登录PP2009.06.13单元2信息查询系统图书信息查询PP2009.6.13读者信息查询PP借阅信息查询PP单元3信息管理系统图书管理图书添加PP2009.6.13图书信息修改PP读者管理读者添加PP读者信息修改PP借阅管理PP单元4 退出系统用户退出PP2009.6.133测试结果及发现3.1测试1（用户登录）输入用户名：Azao 密码：123预测输出：用户名或密码错误，还有2次输入用户名：Azao 密码：预测输出：登录成功3.2测试2（信息查询）图书信息查询输入书号、书名、出版社、作者其中一种信息 预测输出：图书记录读者信息查询输入借书证号、借阅者姓名的其中一种 预测输出：读者信息记录借阅信息查询输入借书证号 预测输出：借阅记录4对软件功能的结论4.1功能1（用户登录）4.1.1能力能够验证用户账号的有效性，实现登录次数的限制4.1.2限制无4.2功能2（信息查询）能够查询读者、图书及借阅信息，查询方式多样，可以模糊查询5分析摘要5.1能力正对现实实现情况，该软件能够对读者、图书、及借阅信息进行管理，如：添加、修改、查询。需要进行系统验证才能对其进行相应的操作；因此具有登陆验证的功能。5.2缺陷和限制在添加信息时，没有对一条信息的添加次数进行限制；在借阅信息查询时，只能按借书证号查询；在添加读者信息后，只有刷新才能更新读者列表；在修改读者信息时，只能选择“借书证号”字段后才能在修改处显示信息在添加借阅信息时，没有解决一天内一本书被借多次的问题；没有图书管理系统进行功能上的丰富，只有3个模块功能。5.3建议能够实现其他功能，完善图书管理系统；改写需求文档，设计文档，使系统的日后维护更加方便；进行系统优化，对消耗资源较多的程序段进行改写提高性能5.4评价考虑到时间的问题，经过这些天大家的共同努力，基本完成了图书管理系统的部分项目需求，但是总的效果还是好的。以后时间充分的话我们将会做的更好，更精细，更符合需求的需要。该软件经过严格的系统测试后，得到了改进和完善，软件质量有了一定提高。6测试资源消耗工作人员水平及数量：测试人员1名：能够进行黑盒测试及白盒测试；测试时间：1天。第4章 实训日记通过一周紧张的实习让我对前面学过的许多课程有了更为深刻的理解，也是我对这几年所学的东西的一个综合体现。这次设计使我感受颇深，让我真正体会到了整个过程给我带来的无奈与快乐。综合起来，主要体现在以下几个方面：首先，急于求成的心情给我带来了很大的困难。主要是开发系统前考虑的问题比较片面，上手操作时相对来说较盲目。给后面的开发带来了很大的不便。但经过查一些相关资料，将问题一一解决了，使得后来的工作才得以顺利进行。其次，在编程语言的熟悉程度也让我对整个开发过程受到了一定的阻碍。因为以前只独立编制过一些简易程序，而那些程序涉及面比较窄，实现的功能相当有限，从而要求对语言的熟悉程序不高。然而这次设计，不但难度大时间短，而且还要求对一些算法比较熟悉，否则将延迟工作速度，必须停下来再去学习，后因时间问题，本系统还有一些不尽如意之处。总的来说，这次的实习设计为我即将踏入社会提供了一次锻炼的舞台。让我对几年来所学的专业课有了更为深刻的认识，使知识得到了融会贯通，得到了比以往学习任何一门课都有大的提高和进步。对于我们来讲，我们每天都在学习，但书本上的东西只是个理