软件文档写作实训 25文档格式.docx
《软件文档写作实训 25文档格式.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训 25文档格式.docx（19页珍藏版）》请在冰豆网上搜索。
第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）记载软件历史。
2.2软件文档所采用的标准
根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：
国际标准、国家标准、行业标准、企业（机构）标准、项目（课题）标准。
ISO9000标准概述：
ISO9000是国际标准化组织建立以来制订和公布的几千个标准中，影响最深远和普及最迅速的一个，其对各国经济生活所起的以下特点作用不可低估。
我们在观察这一现象时，注意到ISO9000的以下几个特点：
（1）国际性。
ISO9000已成为各国对质量保证和质量管理制度的共同理解。
（2）完整性。
（3）兼容性。
作为ISO9000系列标准核心的三个质量保证标准是逐一包容的。
（4）主动性。
选用和实施ISO9000标准、建立质量体系的主体，是企业的主动行为。
（5）可信性。
（6）指导性。
ISO9000标准文本只是给出了质量管理和质量保证的原则，进行创造性的解决。
（7）科学性。
ISO9000标准的背后是现代质量管理的科学原理。
（8）实践性。
具体表现在，标准文本不是空洞的条文，并基于大量的质量管理实践。
2.3软件文档的主要内容
学生信息管理系统软件文档包括5个模块，其具体内容如下：
（1）院系信息管理。
院系信息管理包括院系信息数据的录入、修改与删除等功能。
（2）班级信息管理。
班级信息管理包括班级信息的录入、修改与删除等功能。
（3）教师信息管理。
教师信息管理包括任课教师信息的录入、修改与删除等功能。
（4）学生个人信息管理。
学生信息管理包括学生信息的录入、修改与删除等功能。
（5）课程信息管理。
课程信息管理包括课程信息的录入、修改与删除等。
第3章实例
3.1概要设计实例
概要设计说明书
1引言
1.1编写目的
编写本说明书的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、编写程序系统的组织结构、功能分配、模块划分、接口设计、运行设计、数据结构设计和出错设计等，为程序的详细设计打下基础。
预期读者为：
软件开发人员、项目评审人员、及软件测试人员。
1.2背景
1）待开发的软件系统的名称：
学生信息管理系统。
2）本项目的任务提出者：
学校管理人员。
3）本项目的任务开发者：
学生信息管理系统软件开发小组。
1.3定义
SIMS：
学生信息管理系统
OA：
办公自动化
MIS：
管理信息系统
DataProcessing：
数据处理
TransactionProcessing：
事务处理
DataProcessingCycle：
数据处理流程
DataAcquisition：
数据采集
DataProcessingSystemSecurity：
数据处理系统安全性
1.4参考资料
1）《实用软件文档写作》清华大学出版社肖刚、古辉等编著
2）《软件测试过程管理》机械工业出版社龚波编著
3）《向对象的设计》北京大学出版社邵维忠等编著
4）《管理信息系统》高等教育出版社黄梯云等编著
2总体设计
2.1需求规定
考虑到本系统使用的广泛性，这设计时应该注意它的可移植性；
能方便地将其移植到其它平台。
本系统所管理的是学生的信息应该在一定程度上可以说是学生的隐私，必须注意安全的防范。
同时应用标准的数据格式来实现，以方便数据的共享。
2.2运行环境
硬件环境
用户终端机：
CPUP41.8GHz以上，内存512MB，硬盘20GB以上
服务器：
CPUP41.8GHz以上，内存1GB，高速硬盘组100GB，高速缓存
软件环境
系统建模采用支持UML的CASE工具Rose2004开发环境。
本系统实现语言采用MicrosoftVisualStudio.NET编程。
系统操作平台采用微软的WindowsXP。
服务器端系统的运行环境：
Windows2000Server，WindowsXP。
2.3基本设计概念和处理流程
1）系统模块该系统模块按照输入—>
处理—>
输出的流程进行工作:
图3.1系统流程图
2.4结构
表3.1结构图
层次及编号
模块名称
子程序
实现功能
1第一层
主模块
Main
实现整个系统结构
2第二层
用户输入模块
Userinput
输入用户名及口令
3第二层
输出模块
Output
输出显示
4第三层
系统管理模块
Systemmanagement
系统处理
5第三层
输出管理模块
Display
显示正误信息
6第三层
用户输入处理模块
Useruse
判断用户类型
8第四层
账号信息管理员用户模块
IDmanagement
账号信息管理员权限
9第五层
学生信息管理模块
Studentinformation
学生信息管理
10第五层
据库信息管理模块
Datainformation
数据库信息管理
11第六层
班级信息管理模块
Managerclass
班级信息管理
12第六层
成绩记录管理模块
Managergrade
学生成绩记录信息管理
13第七层
正常显示模块
Rightdisplay
正常显示信息
14第七层
出错显示模块
Errordisplay
出错显示信息
2.5功能需求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：
表3.2分配关系图
登录
退出系统
系统管理
成绩管理
专业管理
班级
管理
课程
档案
用户
操作
浏览功能
√
查询功能
修改功能
增加功能
删除功能
打印功能
2.6人工处理过程
对于用户类型的分类，即用户的分配需要人工处理为系统用户增加用户名及权限。
2.7尚未问决的问题
本系统在处理用户异常输入时，在本时期内还没有具体设计应该如何处理，在设计时将会从分考虑以提高系统的性能。
3接口设计
3.1用户接口
本系统采用图形界面设计，以鼠标和键盘为用户接口，方便用户对专家数据的操作。
3.2外部接口
本系统提供基于Access的数据导入和导出功能，方便各单位和人事的数据交换。
3.3内部接口
系统基于C/S模式开发，系统与数据库服务器之间以BDE连接，保证了数据库系统得无理独立性。
4运行设计
4.1运行模块组合
图3.3整体功能模块图
4.2运行控制
运行控制方式：
通过各种组件，按钮，菜单控制程序的运行，操作步骤根据运用的需要进行。
4.3运行时间
一般的功能模块组合操作的响应时间在1~2秒内，对软磁盘和打印机的操作，以及数据的存储倒入导出也应该在可以接受的时间内完成。
5系统数据结构设计
5.1逻辑结构设计要点
本系统主要有以下几个数据表格：
学生信息，班级信息，专业信息，课程信息，成绩信息，用户信信6个表格的处理。
表3.3学生信息表
数据元素名
类型
备注
Num
char（32）
学号
Name
姓名
Sex
性别
Date
Datetime
出生日期
Place
Char（32）
家庭地址
Polotics
政治面貌
CardNum
Int（10）
身份证号
SpeNum
专业代码
表3.4班级信息
ClassNum
班级编号
ClassName
班级名字
RoomNum
教室编号
MainTeacher
班主任
Total
总人数
表3.5专业信息
int（10）
SpeName
专业名称
Description
5.2数据结构与程序的关系
表3.6数据结构的形式
程序设计的功能模块
涉及的主要表结构
角色信息用户信息
成绩信息
专业信息
班级管理
班级信息
课程管理
课程信息
学生档案管理
学生信息
用户操作
用户信息
帮助
无
6系统出错处理设计
6.1出错信息
程序在运行时主要会出现两种错误：
1、由于输入信息，或无法满足要求时产生的错误，称为软错误。
2、由于其他问题，如网络传输超时等，产生的问题，称为硬错误。
对于软错误：
须在操作成功判断及输入数据验证模块由数据进行数据分析，判断错误类型，再生成相应的错误提示语句，送到输出模块中。
对与硬错误：
可在出错的相应模块中输出简单的出错语句，并将程序重置。
返回输入阶段。
6.2补救措施
所有的客户机及服务器都必须安装不间断电源以防止停电或电压不稳造成的数据丢失的损失。
若真断电时，客户机上将不会有太大的影响，主要是服务器上：
在断电后恢复过程可采用SQLSERVER的日志文件，对其进行ROLLBACK处理，对数据进行恢复。
在网络传输方面，可考虑建立一条成本较低的后备网络，以保证当主网络断路时数据的通信。
在硬件方面要选择较可靠、稳定的服务器机种，保证系统运行时的可靠性。
6.3系统维护设计
维护方面主要为对服务器上的数据库数据进行维护。
可使用SQL
SERVER的数据库维护功能机制。
例如，定期为数据库进行Backup，维护管理数据库死锁问题和维护数据库内数据的一致性等。
必须按照软件产品设计规范的步骤进行开发，并充分考虑软件可维护性，详细编写各阶段的文档资料。
3.2用户手册实例
用户手册
明确用户对学生信息管理系统的功能需求和性能要求，并将这些需求用规格化的语言和规范化的结构完整，准确地表达清楚，以此统一软件开发者和用户对学生信息管理系统软件的理解和认识。
这是开发学生信息管理系统的基础，也是软件开发者和用户达成共识的基础，编写该软件需求分析说明书的目的就在于此。
预期读者：
与学生信息管理系统软件开发有联系的决策人；
程序员；
大学行政人员、教师以及各学生。
1.2背景
系统名称：
安装单位：
高校
开发背景：
随着计算机的发展更多学校采用计算机高级管理系统管理学生信息，这样可以等到更好的管理，所以为了实现该校学生信息办公自动化高级化。
这样提高了工作效率，同时减轻工作压力，为学校教务处开发学生信息管理系统。
1.中华人民共和国国家标准《计算机软件开发规范》
2.中华人民共和国国家标准《计算机软件开发文件编制指南》
3.中华人民共和国国家标准《计算机软件需求说明说编制指南》
2用途
2.1功能
软件功能：
该软件主要功能是实现高校学生信息的管理，具体包括基础信息设置（系别设置，专业设置），班级信息管理（班级信息维护，班级信息浏览），学生基本信息管理（学生基本信息导入，学生基本信息录入，学生基本信息维护，学生基本信息浏览，学生基本信息查询，学生表格打印），系统维护（数据备份，数据还原，数据清理，用户管理，修改密码），帮助，退出系统。
2.2性能
2.2.1精度
在运行此软件时候，对输入数据额精度不作严格要求，若输入数据时文本类型的数据，则其精度要求为最精度的数据；
若输出数据时整型或长整形类型，则其精度要求为保留小数点后一位，而在传输过程中的数据精度不作要求。
2.2.2时间特性
要求系统响应时间，更新处理时间，数据传输，转换时间，计算时间都在1秒以内，即是说系统对指令的响应都是迅速的。
2.2.3灵活性
a.在操作方式方面：
操作指令既可以用鼠标直接点击输入，也可以使用键盘输入快捷键命令；
b.在运行环境方面：
此软件可以在当前的所有windows操作系统上运行使用；
c.在于其他软件皆空方面：
保证此软件可以喝当前大部份打印机相连接；
2.3安全保密
本软件系统在登陆时必须经过身份的验证，但验证为非法用户时，该用户无法登陆系统，此外，在设计到添加、修改、删除学生信息的操作时，系统也会先验证该用户的使用权限，如无权限，这些操作也会中断。
各用户的权限如下：
1）系统超级管理员，对本系统有绝对的管理使用权限，更可以注册新的管理员。
2）系统普通管理员，对本系统有既定的管理使用权限，权限不同，其操作就不同。
3）系统只读管理员，对本系统有既定的管理使用权限，只可以浏览学生的各种信息，而不能更改或添加删除学生信息。
这样可以有效的控制使用权，保证数据的准去，同时查询权也做了限制，对学生信息起到了保密作用。
3运行环境
3.1硬设备
运行软件所需要的硬件设备的最小配置：
奔腾133、内存16兆以上的pc机（硬盘空间为2G）满足输入端条件；
打印机可选。
3.2支持软件
运行本软件所需要的支持软件，如：
a.操作系统：
WindowsxpWindowsNTWindow2000均可运行。
b.编程语言：
VB编程；
c.数据库管理系统的名称和版本号：
windowsXPServer；
后台数据库管理工具是SQL2000
d.其他支持软件：
系统直接调用
3.3数据结构
本系统使用的数据库是SQL2000数据库文件。
4使用过程
软件的功能同系统的输入源结构，输出接受机构之间的相互关系由下文可知。
4.1安装与初始化
只需要用户机器上安装了visualstdio2005和sql2000
启动软件，进入登陆界面。
初始化的用户和密码：
4.2输入
规定输入数据和参量的准备要求
4.2.1输入数据的现实背景
输入数据现实背景主要是：
a.输入数据的来源主要是教学办公室，通过键盘输入到计算机。
b.输入的频度是根据每一项操作状态的函数，一般来说是一年输入一次；
c.没有时间限制；
d.有效的输入范围就是输入各个项，当输入有误时无法跟数据库对应，则不显示任何信息或弹出错误提示，需重新输入；
e.数据本身无保密措施；
f.对输入的数据可做备份转储，无用的数据可以删除；
4.2.2输入格式
数码对初始数据和参量的格式要求，包括语法规则和有关约定，如：
a.长度——int（4）char（20）varchar（50）
b.格式基准——文本，整型，数字等
c.标号——标记或标识符；
d.标点——用来表示行，数据组等的开始或结束而是偶那个的空格、星号、字符组；
按照数据库的字符串长度输入输出：
班级输入：
系别输入：
专业输入：
4.2.3输入举例
为每个完整的输入形式提供样本，包括：
a.控制或首部——用来表示输入的种类和类型的信息，标志符输入日期，正文起点和对所用编码的规定；
b.主体——输入数据的主体，包括数据文卷的输入表述部分；
c.尾部——用来表述输入结束的控制信息，累计字符总数；
4.3输出对每项输出作出说明
4.3.1输出数据现实背景
说明输出数据的现实背景，主要是：
a.使用——学生信息管理人员；
b.使用频度——每周，定期备份查阅；
c.媒体——打印，CRT显示，磁带，卡片，磁盘；
d.质量管理—合理性检查，出错纠正的规定；
e.支配——输入数据是保留还是废弃，分配权限。
4.3.2输出格式
给出对每一类输出信息的解释，主要是：
a.首部——输入数据的标志，输出日期和输出编号;
b.主体——输出信息的主体，包括分栏标题；
c.尾部——包括累计总数，结束标记。
4.3.3输出举例
为每种输出类型提供例子。
对例子中的每一项说明：
a.定义——每项输出信息的意义和用途；
b.来源——是从特定的输入中抽出、从数据库文卷取出、或从软件的计算过程中得到；
c.特性——输出的值域、计量单位、在什么情况下可缺省等。
4.4文卷查询
这一条编写针对具有查询能力的软件，内容包括：
同数据库查询有关的初始化、准备、及处理所需要的详细规定，说明查询的能力、方式、所使用的命令和所要求的控制规定。
如：
对数据的查询
4.5出错处理和恢复
1．用户输入不合法报错。
2．数据库及时备份
4.6终端操作
当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排，连接步骤，数量和参数输入步骤以及控制规定，说明通过终端操作进行查询，检索，修改数据文卷的能力，语言，过程以及辅助性程序等。
第4章实训日记
第1天：
自由分组，选择题目。
我们小组4个人选择的题目是学生信息管理系统。
第2-5天：
网上查阅了大量关于学生信息管理系统软件工程文档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且要对每个细节要进行全面的设计和说明。
第6-13天：
我做的是概要设计和用户手册文档。
首先了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方式按部就班的进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。
第14天：
完成学生管理系统软件工程文档报告，上交作品。
第5章实训总结
随着社会经济的迅速发展和科学技术的全面进步，计算机与通信技术为基础的信息系统正处于蓬勃发展的时期，计算机的应用越来越广泛。
通过实验使我们很好的巩固并掌握了书本知识。
也极大的锻炼了我们的动手能力,分析问题解决问题和应用知识能力，通过实验也使我认识到干事要有耐心，恒心，细心，要有认真的态度！
如果早期的错误隐藏下来，对后面的工作影响就会很大，甚至有时要推倒很多前面做的工作重来。
由于自己的经验及各方面的能力的不足，所以进展的速度非常的缓慢，往往几天的时间还没有一点进展。
此次软件文档写作实训，真正达到了学与用的结合，增强了对软件工程方面应用的理解，在实验过程中，要求本系统进行了系统分析和设计，包括功能需求描述等内容。
介绍了本系统的实现过程，包括系统分析、系统调查、数据流程分析、功能设计、系统物理配置方案、系统实现、系统测试和调试。
从建立数据开始，对数据库理念有了更高的认识，从需求分析，到概念设计和逻辑设计，码方面，我从系统的功能，规模和使用方面考虑。
我对课堂上学的知识再次巩固了一遍。
学会了文档的作用及分类、软件文档所采用的标准、主要内容、软件需求实例、开发计划实例。
通过这次实训，增加了我学习软件技术的兴趣，虽然还不是很明确软件技术包含的具体内容，在此次实训当中加深了对数据库对象的使用。
更加了解其个对象的用处。
学会了前台与后台的链接。
这次实训是老师给了范例程序，经过自己的改写，实现要求。
在实际操作过程中犯的一些错误还会有意外的收获，感觉实训很有意义。
在具体操作中对这学期所学的软件工程的理论知识得到巩固，达到实训的基本目的，也发现自己的不足之出，在以后的上机中应更加注意，同时体会到数据库具有的语句简洁，使用灵活，执行效率高等特点。
发现上机实训的重要作用，特别是对数组和循环有了深刻的理解。
通过本次的课程设计，让我对计算机系统有了更深一步的了解，感觉自己不仅会使用它，而且还会设计它，似乎感觉自己突然间变的强大了许多！
当然，在设计它的时候，也产生的种种的困难，可是最终我还是一个个的把它们解决掉了，这说明，我在不断的进步，不断的向成功迈进。
当然我也意识到自己的不足，在以后的学习生活中需要更加的努力。
参考文献
[1]黄梯云.管理信息系统.高等教育出版
升级会员 