软件文档写作实训报告康闯博客网站.docx
- 文档编号:23633225
- 上传时间:2023-05-19
- 格式:DOCX
- 页数:28
- 大小:113.89KB
软件文档写作实训报告康闯博客网站.docx
《软件文档写作实训报告康闯博客网站.docx》由会员分享,可在线阅读,更多相关《软件文档写作实训报告康闯博客网站.docx(28页珍藏版)》请在冰豆网上搜索。
软件文档写作实训报告康闯博客网站
辽宁工业大学
软件文档写作实训报告
题目:
博客网站系统软件文档
院(系):
软件学院
专业班级:
软件技术081班
学号:
081404022
学生姓名:
安凯辰
指导教师:
王彦华
教师职称:
助教
起止时间:
2010.11.22-2010.12.6
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
081404022
学生姓名
安凯辰
专业班级
软件技术081班
实训题目
博客网站系统软件文档
实训任务
实训任务及要求:
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.2软件文档所采用的标准2
2.3软件文档的主要内容4
第3章实例5
3.1概要设计实例5
3.2用户手册实例5
第4章实训日记14
第5章实训总结25
参考文献26
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程,具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档,通常指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被人和计算机阅读。
它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。
我们知道,硬件产品和产品资料在整个生产过程中都是有形可见的,软件生产则有很大不同,文档本身就是软件产品。
没有文档的软件,不成其为软件,更谈不到软件产品。
软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。
高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要意义。
文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图2.1.1中看出。
软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的。
软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员,并得到必要的支持。
管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料,我们称此为用户文档。
以上三种文档构成了软件文档的主要部分。
图2.1.1文档桥梁作用
2.2软件文档所采用的标准
在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。
可行性分析报告:
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。
项目开发计划:
为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
软件需求说明书(软件规格说明书):
对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。
该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。
概要设计说明书:
该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。
详细设计说明书:
着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。
用户操作手册:
本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。
测试计划:
为做好集成测试和验收测试,需为如何组织测试制订实施计划。
计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告:
测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。
开发进度月报:
该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
项目开发总结报告:
软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。
软件维护手册:
主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。
软件问题报告:
指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。
软件修改报告:
软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。
2.3软件文档的主要内容
可行性研究报告:
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施的方案,说明并论证所选定实施方案的理由。
项目开发计划:
为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
项目开发计划应提供给管理部门,并作为开发阶段评审的参考。
软件需求说明书:
也称软件规格说明书,其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
数据要求说明书:
该说明书应给出数据逻辑描述和数据采集的各项要求,为生成和维护系统数据文卷作好准备。
概要设计说明书:
该说明书是概要设计阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计奠定基础。
详细设计说明书:
着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。
用户手册:
本手册详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。
操作手册:
本手册为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。
测试计划:
为做好组装测试和确认测试,需为如何组织测试制定实施计划。
计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告:
测试工作完成以后,应提交测试计划执行情况的说明。
对测试结果加以分析,并提出测试的结论意见。
开发进度月报:
该月报系软件人员按月向管理部门提交的项目进展情况报告。
报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
项目开发总结报告:
软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。
此外还需对开发工作作出评价,总结出经验和教训。
第3章实例
3.1概要设计实例
1引言
1.1编写目的
《校园博客系统》概要设计书是在需求分析书的基础上进行编写的,本概要设计详细阐述了对用户所提出需求的设计方案,对系统中的各项功能需求、技术需求、实现环境及所使用的实现技术进行了明确定义,为校园博客系统的详细设计、实现、测试以及验收提供参照,也为评价系统功能和性能提供标准。
本概要设计书适用于系统的分析师和程序员以及测试人员阅读和参考。
1.2背景
项目名称:
校园博客系统(CampusBlogSystem)
项目提出者:
辽宁工业大学软件学院
项目开发者:
安厦康闯李东赵东宇
项目用户:
校园网用户
1.3定义
1.3.1术语定义
CBS:
CampusBlogSystem(校园博客系统)
1.3.2缩略语定义
CBS:
CampusBlogSystem(校园博客系统)
1.4参考资料
《Asp.Net实用教程》 郑阿奇主编 电子工业出版社
《校园博客系统需求分析书》内部资料
2总体设计
2.1需求规定
2.1.1系统目标
本校园博客系统是为学院开发的校园网内的博客系统。
随着网络时代的发展,博客的普及,各大门户网站都相应推出自己的博客系统。
校园博客系统是针对校园网开发的自主的博客系统,能适应校园网用户对博客的各种需求,建设属于学院自己的校园博客系统。
2.1.2系统功能
博客模块:
1.个人注册:
个人信息的填写和修改。
2.留言管理模块。
3.评论管理模块。
4.日志管理模块。
日志分类,添加分类,更改分类和删除分类
5.相册管理模块。
6.管理员管理模块。
用户需求功能:
(1)系统为用户提供发布信息功能:
用户可以先通过校园博客首页进入本系统,只需要升入用户名和密码(同时正确),选择发布信息部分就能实现发布信息功能。
(2)系统为客户提供发表日志功能:
用户可以在登录之后,在日志栏里通过添加新日志来写日志。
(3)系统为客户提供查询功能:
在查询窗口里,用户可以实现查询功能(用户输入查询功能)。
(4)系统界面显示功能:
将好友的博客显示在好友列表中并实现超链接。
(5)系统为客户提供在其他用户博客里发表评论的功能,同时显示是哪个用户发表的评论。
(6)系统中,用户可以添加自己日志的分类,同时支持修改或删除日志分类。
(7)为用户提供注册的功能,填写相应的个人资料(注册需要得到管理员审核才能得到自己的博客)。
(8)系统中,检查登陆信息是否正确,如信息正确,则进入自己的博客页面。
(9)系统的客户端在Windows平台下通过IE浏览器进行访问,服务器端可在Windows平台下运行。
系统需要有较好的安全性和可扩展性,并进行及时准确的数据交流和保存。
管理员需求功能:
(1)同样能在校园博客首页进行登录,输入已定的管理员账号密码则能进入,确认账号密码正确后进入管理员后台管理页面。
(2)能对所有校园博客用户的信息进行查看。
(3)在管理界面能对不合乎相关规定的博客用户发表的内容进行警告及删除。
(4)管理员的系统留言有特殊标记,能对所有用户发布系统通告。
2.1.3系统性能
a.数据精确度
1.要按照严格的数据格式输入,否则系统不给予响应进行处理。
2.查询时要保证查全率,所有相应域包含查询关键字的记录都应能查到。
因为通常有文件的记录会很多,所以本系统采用了两种方法进行查询:
直接查询和模糊查询。
b.时间特性要求
运行环境各个页面的链接响应时间不得超过10s,对没进行操作的用户(180s)对其访问认证失效,需要重新登录。
c.灵活性
该系统的设计模块属于普通模式,当要增加新的功能时,接口具有兼容性,可以随时更新。
2.1.4数据管理能力要求
主要是数据库系统,其中包括的数据库有
(1).注册表(登录表)包括用户名、密码等常用信息。
其中用户分为普通用户跟管理员账户。
(2).日志记录包括标题、时间、内容、作者。
(3).留言管理包括回复人、内容及时间。
(4).评论管理包括评论者、内容及时间。
(5).相册管理包括评价和内容。
(6).音乐管理包括音乐名字、链接、人气、上传时间。
2.1.5故障处理要求
a.软件故障:
略
b.硬件故障:
略
2.1.6其他要求
该博客系统必须能适应多种操作系统下的运行,在管理个人的博客时可以管理设置权限,即公开性与不公开性。
2.2运行环境
a.软件环境:
操作系统:
windows(2000、XP、vista、7) Linux
数据库:
SQLServer2005
客户端:
InternetExplore6.0及以上
b.硬件环境:
处理器:
Intel486以上系列、AMDK6以上系列
内存:
1G(非最低配置)
2.3基本设计概念和处理流程
数据库中的设计概念:
本校园博客系统的主要设计在数据库的搭建,各种数据直接的关联调用跟建立各种数据结构,设计满足需求的各种实体及相互关系。
(1)本博客系统规划出不同的实体,其中包括日志目录信息实体,日志内容信息实体,评论信息实体,留言信息实体,照片信息实体,用户信息实体。
关于这些信息,管理员都有权限直接进行修改与删除。
他们直接的关系如下图所示:
a.日志目录信息实体E-R图
b.其他信息实体E-R图
同上
(2)关于数据库表的设计:
a.登入数据表(Load):
包括管理员(Administrator)和用户(User)的信息
列名
数据类型
长度
允许空
Admin_ID
int
10
否
Admin_name
nvarchar
20
否
Admin_password
nvarchar
20
否
User_ID
int
10
否
User_name
nvarchar
20
否
User_password
nvarchar
20
否
b.日志目录信息表(Tags):
包括了ID,目录名称跟分类
列名
数据类型
长度
允许空
Tags_ID
int
10
否
Tags_name
nvarchar
50
否
Tags_Dec
int
200
否
2.4结构
系统结构图:
前台:
前台系统流程图
后台:
后台系统流程图
2.5功能需求与程序的关系
略
2.6人工处理过程
目前尚未发现
2.7尚未解决的问题
目前没有发现
3接口设计
3.1用户接口
本系统采用图形用户接口,以鼠标和键盘为用户接口,方便用户对博客系统的有效操作。
打开校园博客主页面,用户输入正确的用户名和密码就能进入博客系统,否则,将一直停留在主页面或者以游客的身份进行访问。
3.2外部接口
本系统所用的数据库是SQL2005,在和用户进行数据交互的时候是通过服务器及相应的网络。
必须安装Windous2000以上版本。
3.3内部接口
略
4运行设计
4.1运行模块组合
略
4.2运行控制
用户在登录首页面之后,有两种选择方式进行博客系统的访问。
一是登录自己的账号密码进行用户登录,另一种是以游客的身份进行访问博客系统。
而管理员则是直接输入管理员账号密码进入管理员界面。
4.3运行时间
运行环境各个页面的链接响应时间不得超过10s,对没进行操作的用户(180s)对其访问认证失效,需要重新登录。
5系统数据结构设计
5.1逻辑结构设计要点
1.Tags_table
No.
字段名称
类型
Size
NULL
主键
说明
1
Tags_ID
int
10
否
1
目录的编号
2
Tags_name
nvarchar
50
否
目录的名称
3
Tags_Dec
int
200
否
目录的分类
2.其他逻辑结构表
略
5.2物理结构设计要点
通过表于表之间外连接对数据的连续访,修改和删除等。
5.3数据结构与程序的关系
程序实现的功能模板:
校园博客系统
涉及的主要结构:
登录信息表(Load)
日志目录表(Tags)
日志内容信息表(Articles)
评论信息表(Comments)
留言信息表(Messages)
相册信息表(Albums)
6系统出错处理设计
6.1出错信息
关于响应,长时间页面没有响应则自动做出连接超时的处理信息;
关于输入出错的情况,则提示再次输入的信息提示;
关于系统错误,将做自动退出。
6.2补救措施
定期对数据进行备份;对于各种错误做出信息提示,然后采取重新输入或者退出的处理。
6.3系统维护设计
定期重启服务器,保证服务器每两周重启一次,重启之后进行复查,确认服务器已经启动,确认服务器上的各项服务均恢复正常。
并对各个页面进行及时的页面更新,对服务器进行必要的维护来保证用户访问速度。
3.2用户手册实例
1引言
1.1编写目的
该《校园博客系统》辽宁工业大学珠海学院的博客系统,供学生老师进行交流,来加强学校教师和学生之间的了解和交流,教师与教师之间的教学经验的分享,学生与学生之间的学习心得的分享,以及更好的展示该学校老师和学生的风采,丙炔希望通过博客系统的日志积累,形成丰富的教学资源库,真正促进学校的教学工作.
1.2背景
Blog是继Email、BBS、ICQ之后出现的第四种网络交流方式,是网络时代的个人“读者文摘”,是以超级链接为武器的网络日记,是代表着新的生活方式和新的工作方式,更代表着新的学习方式。
它具有“零技术,零成本,零机制,零编辑,零形式”的使用特征,使用简便快捷,任何人都可以建立起自己的博客空间,极具开发交互性,在博客里共享资源,进行深度交流,实现从资源共享到思想共享,相比于我们经常使用的即时通讯工具QQ,博客从交互性,信息共享,信息管理,成本,技术等层面具有独特的优势,它绝不仅仅是一种单向的发布系统,而且有着极具出色的交流功能。
1.3定义
CBS:
CampusBlogSystem(校园博客系统)
1.4参考资料
马平黄冬梅《软件文档写作教程》电子工业出版社2010年5月
《Asp.Net实用教程》 郑阿奇主编 电子工业出版社
《校园博客系统需求分析书》内部资料
2用途
2.1功能
功能的详细划分如表所示:
功能详细划分表
功能设计划分
具体功能
备注
首页(head_main.jsp)
通过点击不同的导航进入不同的页面
文章(head_ArticleList.jsp)
文章列表
通过点击查看全文进入全文显示页面
文章分页
一页显示5篇文章
发表留言
点进进入留言页面
加好友
本功能暂未实现
写文章
只有管理员才能发表文章
阅读数
评论数
发表评论
只有注册为会员才能发表评论
留言(head_disussForm.jsp)
留言显示
留言发表
后台管理(adminmanager.jsp)
用户管理
可查看、删除用户
文章管理
可修改、删除文章
留言管理
进入留言页面进行留言管理
相册(photo.html)
存储相片,图片
1)用户查看文章流程如图所示:
用户查看文章流程图
2)管理员操作流程如图所示:
管理员操作流程图
2.2性能
2.2.1精度
1)管理员信息表如图:
管理员表
2)文章信息表如图:
文章表
3)评论信息表如图:
评论表
4)文章类型信息表如图所示:
文章类型视图
5)用户信息表如图所示:
用户视图
6)朋友圈信息表如图所示:
朋友圈视图
7)照片信息表如图所示:
照片视图
8)投票信息表如图所示:
投票视图
2.2.2时间特性
运行环境各个页面的链接响应时间不得超过10s,对没进行操作的用户(180s)对其访问认证失效,需要重新登录。
2.2.3灵活性
该系统的设计模块属于普通模式,当要增加新的功能时,接口具有兼容性,可以随时更新。
2.3安全保密
对于系统的重要数据都有密码保护,具有一定的安全性。
3运行环境
3.1硬设备
处理器:
Intel486以上系列、AMDK6以上系列
内存:
1G(非最低配置)
3.2支持软件
操作系统:
windows(2000、XP、vista、7) Linux
数据库:
SQLServer2005
客户端:
InternetExplore6.0及以上
3.3数据结构
系统结构图:
前台:
前台系统流程图
后台:
后台系统流程图
4使用过程
4.1安装与初始化
1.首先对压缩包进行解压,具体解压路径自己选择
2.然后进行安装
3.安装过程中一直点击下一步,安装完成
4.2输入
4.2.1输入数据的现实背景
列名
数据类型
长度
允许空
Admin_ID
int
10
否
Admin_name
nvarchar
20
否
Admin_password
nvarchar
20
否
User_ID
int
10
否
User_name
nvarchar
20
否
User_password
nvarchar
20
否
4.2.2输入格式
4.2.3输入举例
管理员表
4.3输出对每项输出作出说明
4.3.1输出数据的现实背景
列名
数据类型
长度
允许空
Tags_ID
int
10
否
Tags_name
nvarchar
50
否
Tags_Dec
int
200
否
4.3.2输出格式
4.3.3输出举例
文章表
4.4文卷查询
功能设计划分
具体功能
备注
首页(head_main.jsp)
通过点击不同的导航进入不同的页面
文章(head_ArticleList.jsp)
文章列表
通过点击查看全文进入全文显示页面
文章分页
一页显示5篇文章
发表留言
点进进入留言页面
加好友
本功能暂未实现
写文章
只有管理员才能发表文章
阅读数
评论数
发表评论
只有注册为会员才能发表评论
留言(head_disussForm.jsp)
留言显示
留言发表
后台管理(adminmanager.jsp)
用户管理
可查看、删除用户
文章管理
可修改、删除文章
留言管理
进入留言页面进行留
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 文档 写作 报告 博客 网站
![提示](https://static.bdocx.com/images/bang_tan.gif)