软件文档写作实训报告：图书馆管理系统软件文档.docx

《软件文档写作实训报告：图书馆管理系统软件文档.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训报告：图书馆管理系统软件文档.docx（20页珍藏版）》请在第一文库网上搜索。

1、软件文档写作实训报告：图书馆管理系统软件文档目录第1章实训目的与要求11.1实训目的11.2实训的实验环境.11. 3实训的预备知识11. 4j11第2章软件文档及其组成22. 1软件文档的作用及分类22. 2软件文档所采用的标准42. 3软件文档的主要内容5第3章实例92.1 测试计划实例92.2 项目开发总结报告13第4章实训日记17第5章实训总结18参考文献19第1章实训目的与要求1.1实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用

2、。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章软件文档及其组成2.1软件文档的作用及分类文档是计算机软件产品的重要组成部分，没有文档就不成其为

3、软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档。软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。开发文档的作用：(1)作为软件生存期个阶段之间的通信工具，记录生成软件需求、设计、编码、测试等的详细规定和说明；(2)描述开发小组的工作职责。通过规定软件规划设计、主题脚本编制、文档编制、质量保证等人员的角色，来定义“如何做”和“何时做

4、”；(3)用作检验点，而允许管理者评估开发进度。如果开发文档缺失或过时，管理者将失去跟踪和控制软件项目的重要工具；(4)形成系统维护人员所要求的基本的软件支持文档，并构成产品文档的一部分；(5)记录软件开发的历史。可行性研究报告的内容：(1)陈述开发目的、要求和限制条件，表达可行性研究的前提条件。(2)对现有系统的描述，进而阐述系统开发的意义和必要性。(3)提出若干新系统的建议方案，并依次进行技术、经济和社会可行性分析(4)在比较多个方案的基础上，得出可行性研究的结论可行性研究报告的要求：软件的开发首先要确切定义用户要求解决的问题，即确定要解决问题的性质、目标和规模。对此，可行性分析人员对所要

5、解决问题的理解是否正确十分关键，因为这决定了开发工作的方向。(1)阐明目标软件的基本要求A性能A输出(如报告、文档或数据，输出项特征，如用途、产生频度、接口及方法对象)A输入(包括数据来源、类型、数量、数据的组织以及提供的频度)A处理流程和数据流程(用图表表示最基本的部分，并辅之以文字说明)A安全和保密方面的要求A与本系统相关联的其他系统(2)说明所建议系统的主要开发目标A人力与设备费用的减少A处理速度的提高A控制精度或生产能力的提高A管理信息服务的改进A自动决策系统的改进A人员利用率的改进(3)说明在该项开发中给出的条件、假定和所受到的限制所建议系统的运行寿命的最小值A进行系统方案选择比较的

6、时间A经费、投资方面的来源和限制A法律和政策方面的限制A硬件、软件、运行环境和开发环境方面的条件和限制A可利用的信息和资源A系统投入使用的最晚时间(4)说明进行可行性研究的方法和评价尺度A说明该项可行性研究的进行方法，所建议的系统的评价方法。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等A说明对系统进行评价时所使用的主要尺度。如费用、各项功能的优先次序、开发时间的长短及使用中的难易程度等(5)对现有系统的分析A现有系统是新系统将来的取代对象，也是新系统的参照对象。对现有系统的分析是为了阐明开发新系统的必要性，同时，也是导出新系统的方案的出发点用户文档用户文档主要负责

7、对软件产品的安装、配置、使用、维护等信息进行描述。包括系统安装配置手册、用户操作手册、软件需求说明书、数据要求说明书等。用户文档的作用(1)为使用和运行软件产品的用户提供培训和运行参考信息；(2)为产品维护工程师提供必要的信息；(3)促进和方便软件产品的市场推广。管理文档管理文档主要是对软件开发过程的管理信息进行描述。管理文档除了前面列表内容，还应该包括被管理者的反馈信息，如各色表格、工作总结、开发体会、产品建议等。软件测试计划文档测试计划起到测试工作过程框架结构的功能，是好的测试工作的基础。一个测试计划的基本内容包括：基本情况分析、测试需求说明、测试策略和记录、测试资源配置、问题跟踪报告、测

8、试计划的评审等。基本情况分析。包括系统运行平台、应用领域、特点和主要功能模块等。分析要点有：测试目的和侧重点、系统适合于测试的内容/操作划分、测试的潜在风险、系统与测试相关的资料说明。测试需求说明。列出测试功能项，规定应该测试的具体内容。测试策略和记录。描述如何开展测试，规定测试记录的内容。必要时，应给出测试记录文档的模板。测试资源配置。针对测试项目的每一个阶段任务，列出所需要的资源，可能的话，给出可能更新需要的空间。问题跟踪报告。报告包括问题的发行者和修改者、问题发生的频率、发现问题的测试用例，以及明确问题产生时的测试环境。问题描述应尽可能是定量、分门别类的列举。问题分为：严重问题、一般问题

9、、建议问题。2.2软件文档所采用的标准CIMS是英文ComputerIntegratedManufacturingSystems或contemporary的缩写，直译就是计算机/现代集成制造系统。计算机集成制造-CIM的概念最早是由美国学者哈林顿博士提出的，其基本出发点是：1）企业的各种生产经营活动是不可分割的，要统一考虑；2）整个生产制造过程实质上是信息的采集、传递和加工处理的过程。CIMS定义：C1MS是通过计算机硬软件。并综合运用现代管理技术、制造技术、信息技术、自动化技术、系统工程技术。将企业生产全部过程中有关的人、技术、经营管理三要素及其信息与物流有机集成并优化运行的复杂的大系统。现

10、代集成制造系统（COntemPoraryIntegratedManufacturingSystem）o将信息技术、现代管理技术和制造技术相结合，并应用于企业全生命周期各个阶段，通过信息集成，过程优化及资源优化，实现物流、信息流、价值流的集成和优化运行，达到人（组织及管理）、经营和技术三要素的集成，以加强企业新产品开发的T、Q、C、S、E,从而提高企业的市场应变能力和竞争力。从功能上看，C1MS包括了一个制造企业的设计、制造、经营管理三种主要功能，要使这三者集成起来，还需要一个支撑环境，即分布式数据库和计算机网络以及指导集成运行的系统技术。1四个功能分系统（1）管理信息分系统（2）产品设计与制造

11、工程设计自动化分系统（3）制造自动化或柔性制造分系统（4）质量保证分系统2.两个支撑分系统（1）计算机网络分系统（2）数据库分系统CIMS集成的内涵集成和连接不同，它不是简单地把两个或多个单元连接在一起，它是将原来没有联系或联系不紧密的单元组成为有一定功能的、紧密联系的新系统。两种或多种功能的集成包含着两种或多种功能之间的相互作用。集成是属于系统工程中的系统综合、系统优化范畴。C1MS的集成，从宏观上看主要是以下5个方面：D系统运行环境的集成2）信息的集成3）应用功能的集成4）技术的集成5）人和组织的集成2.3软件文档的主要内容读者登记，即输入读者的具体信息。输入：读者具体信息。处理：通过图书

12、管理系统写入读者目录文件中。输出：读者具体信息。输入新书的全部信息。输入：新书的全部信息。图书管理系统软件需求分析处理：通过图书管理系统写入图书目录文件中。输出：新书信息的全部内容。查询读者的相关信息。输入：读者信息的关键字（读者编号或姓名）。处理：利用关键字在读者目录文件中找到此编号或姓名读者的相关信息。输出：读者的相关信息。查询图书的信息。信关图类书N书的?(分或输图息时书号公处理：输出：图书的相关信息输入:图书信息的关键字（图书分类号或书名）。利用关博字在图书目录文件中找到此图书分类号或归名图书的相关信息处理：利用关键字在图书目录文件中找到此图书分类号或书名图书的相关信息。输出：图书的相

13、关信息。输入读者借书信息。输入：读者借书信息。处理：通过图书管理系统写入借书文件中。输出：读者借书信息的全部内容查询读者借书的相关信息。输出：借书相关信息处理：信关流书的(党借息铺水利用关键字在借书文件中找到此流水号图V的相关信息输入：借书信息的关键字（流水号）。处理：利用关键字在借书文件中找到此流水号图书的相关信息。输出：借书相关信息。性能精度需求在精度需求上，根据使用需要，在各项数据的输入，输出及传输过程中，可以满足各种精度的需求。时间需求在软件方面，响应时间，更新处理时间都比较快且迅速，完全满足用户要求。灵活性当用户需求。故障处理内部故障处理：在开发阶段可以随即修改数据库里的相应内容。外

14、部故障处理：对编辑的程序进行重装载时，第一次装载认为错，修改。第二次运行，在需求调用时出错，有错误提示，重试。输人输出项主模块1 .输入项目：操作系统传递至的各种消息以及用户的输入数据。2 .输出项目：用户界面显示。学生管理模块1 .输入项目：与学生管理操作子对话框有关的用户输入及系统消息。2 .输出项目：操作结果显示。图书管理模块1 .输入项目：用户口令。2 .输出项目：相应的界面。借阅管理模块1 .输入项目：学生学号、图书编号。2 .输出项目：学生信息、相关借书信息。归还管理模块1 .输入项目：图书编号。2 .输出项目：相关学生信息。流程逻辑登陆模块人机界面设计：系统响应时间：学生或管理人员登陆的响应时间应稳定在IS左右；出错信息处吁若学生或管理人员输入的帐号和密码不匹配或输入不存在的帐号，系统应友好进行提示，如提示youarenotasystemuser!”学生登记程序描述：实现学生信息登记功能输入项：字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期输出项：字符串表示的汉字，字符串最大长度是10；整数类型的数字和时间类型的日期算法：学生登记的程序设计流程图如下学生查询程序描述：实现学生信息查询功能输入项：用字符串表示的汉字，字符串最大长度是10；整数类型的数字，最长不超过6输出项：用字符串表示的汉字，字符串