学生管理系统软件文档软件文档写作实训报告

辽宁工业大学软件文档写作实训报告

题目：学生管理系统软件文档

院（系）: 软件学院

专业班级：

学号：

学生姓名：

指导教师：丁宝柱

教师职称：

起止时间：2012.12.03-2012.12.09

实训任务及评语

目录

第1章实训目的与要求 (1)

1.1 实训目的 (1)

1.2 实训的实验环境 (1)

1.3 实训的预备知识 (1)

1.4 实训要求 (1)

第2章软件文档及其组成 (2)

2.1软件文档的作用及分类 (2)

2.2软件文档所采用的标准 (3)

2.2 软件文档的主要内容 (3)

第3章实例 (4)

3.1 ******实例 (4)

3.2 ******实例 (6)

第4章实训日记 (7)

第5章实训总结 (8)

第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)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。

文档在各类人员、计算机之间的多种桥梁作用中看出：

既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发。

规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。对于充分发挥软件产品的效益，都有着重要的意义。

软件文档从形式上来看，大致可分为两类：

一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。

软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。

按照文档产生和使用的范围，软件文档大致可分为三类：

（1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。

（2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。

（3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。

2.2软件文档所采用的标准

根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国际标准: ISO、国际标准化组织、国家标准:GB中国ANSI美国BS英国JIS日本、行业标准: IEEE 、企业(机构)标准: IBM项目(课题)标准: CIMS 。

标准标准标准

2.2 软件文档的主要内容

软件文档的主要内容包括引言、任务概述，需求规定和运行环境规定。

引言包括：编写的目的、背景、定义和参考资料。

编写的目的是说明编写这份需求说明书的目的，指出预期的读者。背景开发包括：待开发的系统的名称、本项目的任务提出者、开发者、用户、该系统同其他系统或其他机构的基本的相互来往关系。定义是指列出本文件中用到的专门术语的定义和外文首字母组词的原词组。参考资料是指需要列出用得着的参考资料。

任务概述包括：目标、用户的特点、假定和约束。

目标是指叙述该系统开发的意图、应用目标、作用范围以及其他应向读者说明的有关该系统开发的背景材料。解释被开发系统与其他有关系统之间的关系；用户的特点是指列出本系统的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本系统的预期使用频度；假定和约束是指列出进行本系统开发工作的假定和约束。

需求规定包括：对功能的规定、对性能的规定、精度、时间特性要求、灵活性、输入输出要求、数据管理能力要求(针对软件系统)、故障处理要求和其他专门要求。

对功能的规定是指用列表的方式，逐项定量和定性地叙述对系统所提出的功能要求，说明输入什么量、经怎么样的处理、得到什么输出，说明系统的容量,包括系统应支持的终端数和应支持的并行操作的用户数等指标；精度是说明对该系统的输入、输出数据精度的要求，可能包括传输过程中的精度；时间特性要求是说明对于该系统的时间特性要求；灵活性是说明对该系统的灵活性的要求，即当需求发生某些变化时，该系统对这些变化的适应能力；输入输出要求是指解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对系统的数据输出及必须标明的控制输出量进行解释并举例；数据管理能力要求(针对软件系统)是指说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算；故障处理要求是指列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求；其他专门要求是指如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。

运行环境规定包括：设备、支持软件、接口和控制。设备是指列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：处理器型号及内存容量、外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量、输入及输出设备的型号和数量，联机或脱机；、数据通信设备的型号和数量和功能键及其他专用硬件；支持软件是指列出支持软件，包括要用到的操作系统、编译程序、测试支持软件等；接口是说明该系统同其他系统之间的接口、数据通信协议等；控制是说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。