关键名词
含义备注用户
指使用此系统发表帖子的人员
管理员
指具有管理版内帖子,删除帖子的权利的人员。
发布帖子用户通过此业务按系统规则
进行帖子的发布。
帖子不包含敏感词 管理版内帖子管理员通过此业务按系统规
则在自己管理的版块内对帖
子进行审核,过滤等操作
Javascript JavaScript是一种能让你的javascript
操作手册
操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。
具体的内容要求如下:
一、引言
1.1编写目的
帮助BBS 论坛系统的管理维护人员、后台页面管理人员以及前台用户,全面了解系统的功能,快速掌握操作方法。
预期读者为:使用本系统的用户操作人员以及管理员
1.2背景
1)名称:论坛留言板;
2)项目任务提出者:王老师 ;
3)项目任务开发者:软件1013班JSP 第一组;
4)用户:访问留言板的读者;
5)实现该项目的计算中心或网络:软件学院网络实验室;
6)该软件系统同其他系统或其他机构的基本的相互来往关系:该软件系统的开发过程相对而言比较轻松,主要在软件学院的实验室开发,同时也少不了王老师的帮助。
1.3定义
网页更加生动活泼的程式语言,也是目前网页中设计中最容易学又最方便的语言
JSP是由Sun Microsystems公司
倡导、许多公司参与一起建
立的一种动态网页技术标准Java Server Pages
ASP是微软公司开发的代替CGI脚
本程序的一种应用,它可以
与数据库和其它程序进行交
互,是一种简单、方便的编
程工具Active Server
Page
HTML超文本标记语言,是用于描述
网页文档的一种标记语言.Hypertext markup language
1.4参考资料
《软件文档写作》高林主编
《计算机导论》黄国兴编注
《软件工程》机械工业出版社
《数据库原理》清华大学出版社
JSP程序设计教程
《BBS论坛系统项目开发计划书》
《BBS论坛系统项目需求说明书》
《BBS论坛系统概要设计说明书》
《BBS论坛系统详细设计说明书》
《BBS论坛系统数据库设计说明书》
二、软件概述
2.1软件的结构
2.2程序表
(1)精度:本系统对精度方面没有具体的要求。
(2) 时间特性:页面响应时间:打开每个页面不超过3s。
(3)灵活性:本软件是基于纯java编写的本地软件,具有极好的可移植性。
可以在任何平台上运行(安装了jdk的平台)。
而且因为java具有极好的特性本软件也不会浪费内存和占用资源是一个非常好的本地软件。
2.3文卷表
本系统不涉及网络而且外部网络程序无法读取程序的内部数据因此本软件具有极好的安全性。
三、安装与初始化
3.1硬设备
一般的计算机(配置一般的处理器和内存,输入输出设备)即可,存储器容量>10G
3.2支持软件
操作系统:Windows 2000 / XP / Vista / 7
Web容器:JDK5.0、Tomcat5
数据库:MYSQL
3.3数据结构
本软件的运行所需要的数据库:MYSQL
四、运行说明
4.1运行表
可能的运行运行目的
运行1:用户注册用户输入一些基本信息,录入数据
库
运行2:用户登录查询数据库中的用户表,判断,用
户进行登录操作
运行3:用户留言用户输入留言,插入数据库到留言
表
4.2运行步骤
步骤一:用户进入用户注册页面index.jsp,输入一些信息进行用户注册步骤二:用户进入用户登录页面login.jsp,输入用户用户名和密码进行用户登录
步骤三:进入用户留言界面msg.jsp,输入留言,点击“发表留言”,此
时,查看用户登录状态若没有登录返回login.jsp页面进行登录,若没有账号,则进入index.jsp页面,进行用户的注册。
若用户已经登录,则录入留言信息进入数据库,并且提示留言是否发表成功。
4.3运行1(用户注册)说明
1)运行控制
运行流向控制没有特殊要求
2)操作信息
操作要求:
启动方法:当在相应的用户注册文本框内输入相应数据,并且
单击“注册”时,启动用户注册的运行
预计运行时间:3~5min
3)输入输出文卷
输入:输入用户名,密码,
文卷的标识符或标号:t_user表
记录媒体:数据库
4)输出文段
文字容量:t_user表中的所有字段
分发对象:数据库
保密要求:加密发送
5)恢复过程
当用户注册运行出现故障时,首先重启服务器,然后重新部署项目,查看MyEclipse控制台消息,进入debug模式进行调试
4.4运行2(用户登录)说明
1)运行控制
运行流向控制没有特殊要求
2)操作信息
操作要求:
启动方法:当在相应的用户登录框输入相应的用户名和密码,
点击“登录”按钮,启动用户登录运行
预计运行时间:50s
3)输入输出文卷
输入:输入用户名,密码
保密要求:用户名明文发送,密码加密发送
4)输出文段
文字容量:用户名:varchar(20),密码:varchar(20)
分发对象:数据库
保密要求:密码加密发送
5)恢复过程
进入MySQLClient的mysql控制台,在dos界面上查询数据库中是否存在该用户的信息,如果存在该用户却登陆不了,则检查源代码
4.5运行3(签写留言)说明
1)运行控制
运行流向控制没有特殊要求
2)操作信息
操作要求:
启动方法:当在相应的签写留言页面,签写留言,当单击“发表
留言”时,启动签写留言运行
预计运行时间:1min~3min
3)输入输出文卷
输入:输入用户名,留言标题,留言内容进入t_msg表
记录媒体:数据库
保密要求:明文发送
4)输出文段
文字容量:text
分发对象:数据库
保密要求:加密发送
5)恢复过程
当签写留言运行出现故障时,首先重启服务器,然后重新部署项目,查看MyEclipse控制台消息,进入debug模式进行调试
五、非常规过程
5.1非常规问题
表5-1非常规问题
问题解决方法或应急措施
会员登录不了联系管理员,查看数据库驱动是
否正常。
管理员不能登录至后台重启数据库或者查看数据库驱动
是否正常。
会员留言信息丢失恢复数据库备份文件。
会员不能留言联系管理员,查看数据库是否已
达上限。
管理员错删留言恢复数据库备份文件。
不良留言大量出现第一时间关闭数据库,迅速删除
后再启动数据库以及服务器
会员强制下线第一时间通知管理员,先把该帐
号冻结,查明情况后再恢复。
会员信息被修改第一时间通知管理员,先冻结帐
号,查询两次IP地址,由申诉人
员提供注册时准确信息,如一
致,则用该会员的备份文件覆盖
后的信息。
5.2维护人员需知
1 定期查看数据库驱动以及数据库是否达到上限
2 完善备份数据库,出现相关问题第一时间启用备份数据库
3 保存好备份文件,遇到相关问题可以调用备份文件,保证系统运行
4 系统安全性完善,确保遭受攻击还能够继续运行
5 系统安全性完善,确保会员信息不泄露或盗取
6 登录界面安全性完善,确保无木马程序侵入
六、远程操作
本系统不涉及相关的远程操作,因此不作赘述。