软件文档写作实训.docx
- 文档编号:15060540
- 上传时间:2023-06-30
- 格式:DOCX
- 页数:25
- 大小:29.41KB
软件文档写作实训.docx
《软件文档写作实训.docx》由会员分享,可在线阅读,更多相关《软件文档写作实训.docx(25页珍藏版)》请在冰点文库上搜索。
软件文档写作实训
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
学生姓名
专业班级
实训题目
网上购物系统软件文档
实训任务
实训任务及要求:
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复,文档要严格按照所采用的标准编写,图表布局要合理规范。
指导教师评语及成绩
成绩:
指导教师签字:
年月日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.1.1软件文档的作用2
2.1.2软件文档的分类3
2.2软件文档所采用的标准4
2.3软件文档的主要内容5
第3章实例6
3.1软件需求文档6
3.2用户手册8
第4章实训日记15
第5章实训总结16
参考文献17
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程,具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
2.1.1软件文档的作用
1.管理依据
在软件开过过程中,管理者必须了解开发进度、存在的问题和预期目标。
每一阶段计划安排的定期报告提供了项目的可见性。
定期报告还提醒各级管理者注意该部门对项目承担的责任以及该部门效率的重要性。
开发文档规定若干个检查点和进度表,使管理者可以评定项目的进度,如果开发文档有遗漏,不完善,或内容陈旧,则管理者将失去跟踪和控制项目的重要依据。
2.任务之间联系的凭证
大多数软件开发项目通常被划分成若干个任务,并由不同的小组去完成。
学科方面的专家建立项目,分析员阐述系统需求,设计员为程序员制定总体设计,程序员编制详细的程序代码,质量保证专家和审查员评价整个系统性能和功能的完整性,负责维护的程序员改进各种操作或增强某些功能。
这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的,因而,任务之间的联系是文档的一个重要功能。
大多数系统开发方法为任务的联系规定了一些正式文档。
分析员向设计员提供正式需求规格说明,设计员向程序员提供正式设计规格说明,等等。
3.质量保证
那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明;必须制订测试计划和测试规程,并报告测试结果;他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。
这些文档的提供可满足质量保证人员和审查人员上述工作的需要。
4.培训与参考
软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作,以及为了达到他们的各自的目的,如何使用系统。
5.软件维护支持
维护人员需要软件系统的详细说明以帮助他们熟悉系统,找出并修正错误,改进系统以适应用户需求的变化或适应系统环境的变化。
6.历史档案
软件文档可用作未来项目的一种资源。
通常文档记载系统的开发历史,可使有关系统结构的基本思想为以后的项目利用。
系统开发人员通过审阅以前的系统以查明什么部分已试验过了,什么部分运行得很好,什么部分因某种原因难以运行而被排除。
良好的系统文档有助于把程序移植和转移到各种新的系统环境中。
2.1.2软件文档的分类
下面给出软件文档主要类型的大纲,这个大纲不是详尽的或最后的,但适合作为主要类型软件文档的检验表。
而管理者应规定何时定义他们的标准文档类型。
软件文档归入如下三种类别:
a)开发文档——描述开发过程本身;
b)产品文档——描述开发过程的产物;
c)管理文档——记录项目管理的信息。
1.开发文档
开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一类文档,开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储等)。
开发文档起到如下五种作用:
a)它们是软件开发过程中包含的所有阶段之间的通信工具,它们记录生成软件需求、设计、编码和测试的详细规定和说明;
b)它们描述开发小组的职责。
通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做;
c)它们用作检验点而允许管理者评定开发进度。
如果开发文档丢失、不完整或过时,管理者将失去跟踪和控制软件项目的一个重要工具;
d)它们形成了维护人员所要求的基本的软件支持文档。
而这些支持文档可作为产品文档的一部分;
e)它们记录软件开发的历史。
基本的开发文档是:
——可行性研究和项目任务书;
——需求规格说明;
——功能规格说明;
——设计规格说明,包括程序和数据规格说明;
——开发计划;
——软件集成和测试计划;
——质量保证计划、标准、进度;
安全和测试信息。
2.产品文档
产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。
产品的文档起到如下三种作用:
a)为使用和运行软件产品的任何人规定培训和参考信息;
b)使得那些未参加开发本软件的程序员维护它;
c)促进软件产品的市场流通或提高可接受性。
产品文档用于下列类型的读者:
——用户——他们利用软件输入数据、检索信息和解决问题;
——运行者——他们在计算机系统上运行软件;
——维护人员——他们维护、增强或变更软件。
产品文档包括如下内容:
——用于管理者的指南和资料,他们监督软件的使用;
——宣传资料通告软件产品的可用性并详细说明它的功能、运行环境等;
——一般信息对任何有兴趣的人描述软件产品。
基本的产品文档包括:
——培训手册;
——参考手册和用户指南;
——软件支持手册;
——产品手册和信息广告。
3.管理文档
这种文档建立在项目管理信息的基础上,诸如:
——开发过程的每个阶段的进度和进度变更的记录;
——软件变更情况的记录;
——相对于开发的判定记录;
——职责定义。
这种文档从管理的角度规定涉及软件生存的信息。
2.2软件文档所采用的标准
1.根据软件工程标准制定的机构和标准适用的范围,可分为5个层次:
(1)国际标准:
ISO国际标准化组织
(2)国家标准:
GB中国ANSI美国BS英国JIS日本
(3)行业标准:
IEEE
(4)企业(机构)标准:
IBM
(5)项目(课题)标准:
CIMS
2.基本标准包括:
(1)软件工程术语,标准号为GB/T11457-1989;
(2)信息处理——数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定,标准号为GB/T1526-1989;
(3)软件工程标准分类法,标准号为GB/T15538-1995;
(4)信息处理——程序构造及其表示法的约定,标准号为GB/T13502-1992;
(5)信息处理——单命中判定表规范,标准号为GB/T15535-1995(ISO5806);
(6)信息处理系统——计算机系统配置图符号及其约定,标准号为GB/T14085-1993(ISO8790)。
3.开发标准包括:
(1)信息技术——软件生存期过程,标准号为GB/T8566-1995;
(2)软件支持环境,标准号为GB/T15853-1995;
(3)信息处理——按记录组处理顺序文卷的程序流程,GB/T15697-1995(ISO6593);
(4)软件维护指南,标准号为GB/T14079-1993。
4.文档标准包括:
(1)计算机软件产品开发文档编制指南,标准号为GB/T8567-1988;
(2)计算机软件需求说明编制指南,标准号为GB/T9385-1988;
(3)软件文档管理指南,标准号为GB/T16680-1996。
5.管理标准包括:
(1)计算机软件配置管理计划规范,标准号为GB/T12505-1990;
(2)信息技术——软件产品评价质量特性及其使用指南,标准号为GB/T16260-1996;
(3)计算机软件质量保证计划规范,标准号为GB/T12504-1990;
(4)计算机软件可靠性和可维护性管理,标准号为GB/T14394-1993。
2.3软件文档的主要内容
本软件文档是网上购物系统软件文档。
网上购物系统软件文档包括:
网上购物系统操作手册、网上购物系统测试计划、网上购物系统概要设计说明书、网上购物系统可行性分析报告、网上购物系统需求说明书、网上购物系统详细设计说明书、网上购物系统项目计划、网上购物系统项目总结报告、网上购物系统用户手册。
首先,网上购物系统分为以下几个功能:
系统设置、商品供应商信息管理、商品信息管理、商品管理、销售管理、销售数据查询。
我在这个管理系统软件文档所作的内容为:
需求分析:
需求分析是指对要解决的问题进行详细的分析,弄清楚问题的要求,包括需要输入什么数据,要得到什么结果,最后应输出什么。
可以说,在软件工程当中的“需求分析”就是确定要计算机“做什么”。
虽然功能需求是对软件系统的一项基本需求,但却并不是唯一的需求,通常对软件系统有下述几方面的综合要求。
1.功能需求
2.性能需求
3.可靠性和可用性需求
4.出错处理需求
5.接口需求
6.约束
7.逆向需求
8.将来可能提出的要求
用户手册:
用户手册中,要列出本文件中用到的专门术语的定义和外文首字母组词的原词组,列出有用的参考资料,如:
项目的经核准的计划任务书或合同、上级机关的批文;属于本项目的其他已发表文件;本文件中各处引用的文件、资料,包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够取得这些文件资料的来源等
第3章实例
3.1软件需求文档
1引言
1.1编写目的
网上商城是一个融合了电子商务以及网络社区特色的产品,它不仅能使您的电子商务进程变得异常轻松,同时通过和社区相关产品的结合还能进一步提高用户的活跃度以及黏性,从而促进用户的忠诚度。
1.2背景
网上商城为了方便顾客需求,购物只需简单注册和几个简单的操作就可以进行下单购物,多种商品检索方式,便捷的购物流程,符合B2C电子商务的用户体验,使顾客可以快速方便地找到符合自己要求的商品并下单购物。
完善的订单管理流程使店长和用户可以方便地跟踪和查看自己的订单状态,并及时进行操作和管理,使整体的购物流程易于管理和操作。
1.3定义
222-eStore:
网上购物系统
UML,UnifiedModelingLangage(统一建模语言)的缩写,是一个标准的建模语言。
JSP,JavaServerPage(Java服务器页面)的缩写,一个脚本化的语言。
1.4参考资料
JAVAWEB开发实战经典基础篇.李兴华,王月清.清华大学出版社,2010
JSP应用开发技术.贾素玲,王强.清华大学出版社,2008
JSP程序开发基础教程与实验指导.王晓军,田中雨等.清华大学出版社,2010
JSP项目开发案例全程实录(第2版).明日科技.清华大学出版社,2010
软件工程国标文档GB8567——88
2任务概述
2.1目标
本系统的设定目标如下:
·系统能够提供友好的用户界面,使操作人员的工作量最大限度的减少;
·系统运行的效率一般,但是运算出结果所需的时间应该是用户在可以接受的范围内(<=30秒);
·系统应有良好的可扩充性,可以容易的加入其它系统的应用;·系统能够存储一定量的商品信息,并方便有效地进行商品数据操作和管理;
·平台的设计具有一定的超前性,灵活性,能够适应商品管理的变化;
·系统能够对一定量的会员进行相应的信息存储和管理,
·系统能够提供一定的安全机制,提供数据信息安全访问,防止随意删改;
·通过这个项目可以锻炼自己,提高开发能力和项目管理能力。
2.2用户的特点
本系统的用户主要为进行网上物品销售及相关人员,包括系统管理员、销售人员、销售管理员、客户服务人员、会员管理者及会员等。
2.3假定和约束
系统的实现约束如下:
a)操作系统为Windows2000
b)开发平台为:
MyEclipse6.0
c)数据库为SQLserver2000
3需求规定
3.1对功能的规定
网上购物在线网站致力于提供产品展示及订购为核心的网上购物服务宣传自己商店的产品并将自己的产品展现给客户,让客户通过网站便能对自由的选择地购买产品。
该网站是通过用户登录浏览商品、购买、确定购买、实现用户模块功能。
其中订单的生成,网站后台系统,通过系统管理员管理商品、订单、用户来实现。
3.2对性能的规定
3.2.1精度
A.要按照严格的数据格式输入,否则系统不予进行响应处理。
B.查询时要保证查全率,所有相应域包含查询关键字的记录都应该能查到,因为通常有文件的记录会很多,所以本系统采用了两种方法进行查询:
直接查询和模糊查询。
3.2.2时间特性要求
无论是客户端还是管理端,当用户登录,进行任何操作的时候,系统应该及时地进行反应,反应的时间在5秒以内。
系统应能监测出各种非正常情况,如与设备的通信中断,无法连接数据库服务器等,以避免出现长时间等待甚至无响应。
3.2.3灵活性
满足网络业务平台的要求,对前面提到的环境要求不应存在困难
3.3输人输出要求
使用——这些输出数据时为了给参与者使用
使用频度——每周的、定期的
媒体——打印、卡片、磁盘,
质量管理—一当出现任何问题都将停止交易,由开发者进一步检查。
支配——只有注册用户才能拥有订购商品的权利
使用——这些输出数据时为了给参与者使用
使用频度——每周的、定期的
媒体——打印、卡片、磁盘,
质量管理—一当出现任何问题都将停止交易,由开发者进一步检查。
支配——只有注册用户才能拥有订购商品的权利
3.4数据管理能力要求
3.5故障处理要求
如果有任何错误产生,开发商将第一时间终止网站,进行维护和检查。
确保其快速恢复。
3.6其他专门要求
4运行环境规定
4.1设备
本系统的硬件环境如下:
客户机:
普通PC
·CPU:
P41.8GHz以上
·内存:
256MB以上
·能够运行IE5.0以上或者Netscape4.0以上版本的机器
·分辨率:
推荐使用1024×768像素
Web服务器
·CPU:
P41.0GHz
·内存:
1G以上
·硬盘:
80GB以上
·网卡:
KMb/s速度
数据库服务器
·CPU:
P42.0GHz
·内存:
1GB以上
·硬盘:
80GB以上
4.2支持软件
本系统的软件环境如下:
·操作系统:
UNIX/Linux/Windows2000或以上版本
·数据库:
SQLServer2000
·开发工具包:
JDKVersion1.5
·Web服务器:
Tomcat6.0
·浏览器:
IE5.0以上
4.3接口
MICROSOFT的NETBEUI
NOVELL的IPX/SPX
交叉平台TCP/IP。
4.4控制
3.2用户手册
用户手册(GB8567——88)
1引言
1.1编写目的
编写该文档的目的在于明确网上购物系统的用户需求,使得软件开发人员与用户对待开发软件的需求有统一的、无二义性的认识。
该文档所描述的内容,可作为软件确认测试的依据。
该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。
1.2背景
小王长期一个人经营商店,货物的进销存等环节工作量大,耗资耗力,使得商店的经营成本高,效益低,应经不适应当今这个快节奏的社会了。
并且,随着Internet的发展,网上购物已经被大多数用户所接受。
为了改善商店的经营状况,拓宽商店的经营范围,商店老板小王委托计算机专业的学生做一个网上购物系统,使自己的货物被更多的用户知道,扩大销售量,从而提高效益。
1.3定义
222-eStore:
网上购物系统
UML,UnifiedModelingLangage(统一建模语言)的缩写,是一个标准的建模语言。
JSP,JavaServerPage(Java服务器页面)的缩写,一个脚本化的语言。
1.4参考资料
《软件工程课程设计》机械工业出版社李龙澍郑诚等编著
《java设计模式》清华大学出版社耿祥义张跃平
《JSP程序设计教程》郭真,王国辉编著
软件工程国标文档GB8567——88
2用途
2.1功能
前台功能:
网站介绍:
主要是对本网店的一些介绍,使用户能快速了解网店。
货物浏览:
普通用户和会员可以对货物进行浏览。
在页面上,应向用户显示货物类别,用户选择了某个类别之后,应能显示该类别下的实际物品(如果有)的信息:
物品图片、物品名称、市场价、折扣、会员价,当物品数目过多时,要提供分页浏览功能。
购物车:
购物车中要列出用户所选择的物品名称、市场价、会员价、折扣和数量,总计金额,共节省金额。
用户可以:
删除购物车中的物品;
修改某个物品的数量、物品的金额和总计金额;
清空购物车;
结算:
到结算页面确认并下订单。
结算:
结算前必须再次验证用户,验证合法后,进入结算页面,显示订单的日期、收货信息、购买物品清单,用户还可以再次修改收货人信息,修改或删除已选物品,当确认后,可以选择下订单。
订单生成与管理:
购物后,确认支付和配送方法后生成订单。
在生成订单的同时,系统发邮件通知书店管理员。
会员还可以查询自己订单的处理情况和历史订单。
验证合法的用户可查看在网站上成交的订单,包括订单的个数,总计金额,订单的列表。
列表项包括:
订单号、订单日期、收货人、订单金额、订单状态,当订单数目过多时,要提供分页浏览功能。
对于列表的订单,用户可以:
查看订单详细信息:
生成一个订单的详细信息页面,包括:
订单号、收货人、联系电话、送货地址、用户订购的物品列表(序号、物品编号、原价、订购数量、折扣、销售价)、金额总计、订购日期。
在页面上提供直接打印的功能;
修改订单:
只允许对未审核的订单进行修改(包括修改收货人、联系电话、送货地址、用户订购的物品列表);
删除订单:
只允许对未审核的订单进行删除。
用户留言:
可自由留言。
包括留言列表、留言内容、发布留言
公告:
显示公告信息。
联系我们:
用户可以将联系信息以表单的形式提交给网店。
会员管理:
包括普通用户注册成为会员;每个注册会员,有一个个人中心,即属于自已的帐户管理界面,可以轻松的管理个人基本资料,如进行资料的修改;会员还可以通过输入账号来找回密码。
货物查询:
货物查询的目的是为了帮助用户快速地找到想要购买的货物。
可以进行模糊查询,也可以进行高级搜索查询。
物品分类:
物品按不同的所属范围进行分类。
货物展台:
货物展台包括特价书、新品上市、热卖商品、货物订购。
后台功能:
用户管理:
主要包括用户注册、用户登录和用户信息修改。
网上书店的用户主要有两个:
普通用户、会员和管理员。
普通用户可以通过注册成为书店会员。
每个注册会员,有一个属于自已的帐户管理界面,可以轻松的管理个人基本资料,如进行资料的修改。
书店管理员可以对个人基本信息进行修改,并拥有系统的所有功能权限。
商品管理:
管理员可以对商品进行添加、修改和删除,普通用户和会员可以对商品进行浏览。
在页面上,应向用户显示书籍类别,用户选择了某个类别之后,应能显示该类别下的实际书籍(如果有)的信息:
书籍图片、书籍名称、市场价、折扣、会员价,当书籍数目过多时,要提供分页浏览功能。
购物管理:
普通用户和会员都可以对商品进行查询,会员可以把要买的书添加到购物车里,还可以将购物车里不想买的书删除。
订单管理:
会员购物后,确认支付和配送方法后生成订单。
会员还可以查询自己订单的处理情况和历史订单。
会员可查看在网站上成交的订单,包括订单的个数,总计金额,订单的列表。
列表项包括:
订单号、订单日期、收货人、订单金额、订单状态,当订单数目过多时,要提供分页浏览功能。
对于列表的订单,会员可以:
查看订单详细信息:
生成一个订单的详细信息页面,包括:
订单号、收货人、联系电话、送货地址、用户订购的书籍列表(序号、书籍编号、原价、订购数量、折扣、销售价)、金额总计、订购日期。
在页面上提供直接打印的功能;
修改订单:
只允许对未审核的订单进行修改(包括修改收货人、联系电话、送货地址、用户订购的书籍列表);
删除订单:
只允许对未审核的订单进行删除。
公告管理:
管理员可以对公告进行添加和删除。
留言管理:
会员可以对商品进行评论,即添加评论。
管理员可以对会员发表的评论进行删除。
2.2性能
2.2.1精度
A.要按照严格的数据格式输入,否则系统不予进行响应处理。
B.查询时要保证查全率,所有相应域包含查询关键字的记录都应该能查到,因为通常有文件的记录会很多,所以本系统采用了两种方法进行查询:
直接查询和模糊查询。
2.2.2时间特性
一般操作的响应时间在0.2秒。
2.2.3灵活性
满足网络业务平台的要求,对前面提到的环境要求不应存在困难
2.3安全保密
可以保证用户信息不被外界获取。
基本实现用户安心的使用。
3运行环境
3.1硬设备
本系统的硬件环境如下:
客户机:
普通PC
·CPU:
P41.8GHz以上
·内存:
256MB以上
·能够运行IE5.0以上或者Netscape4.0以上版本的机器
·分辨率:
推荐使用1024×768像素
Web服务器
·CPU:
P41.0GHz
·内存:
1G以上
·硬盘:
80GB以上
·网卡:
KMb/s速度
数据库服务器
·CPU:
P42.0GHz
·内存:
1GB以上
·硬盘:
80GB以上
3.2支持软件
Myeclipse
DreamweaverCS3
Fireworks
Tomcat6.0
Mysqlserver
3.3数据结构
1管理员表(登录名,密码)
Tb_admin(name,password)
名称
类型
空
默认值
备注
Name
Varchar(20)
no
主键
Password
Varchar(20)
no
主键
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 文档 写作