新闻发布系统详细设计说明书
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
5.12测试计划
a．若新建管理员时密码长度长度超过限制字长，则提示“密码必须 小于指定字长”，若没超过则满足要求。
b．若新建的管理员帐号为空，则提示“请重新输入帐号的名称”若 是则满足要求。
c. 若新建的管理员帐号与数据库中已有的管理员帐号重复，则提 示“请重新输入帐号的名称”。若是，则满足要求。 d. 出现写数据库错误，则提示无法连接的具体原因。若是，则满足要 求。
删除一个新闻信息的第一步，只有当查找到合理的所需删除的新闻
内容，才可以建立其隶属的关系，然后再删除录入新闻消息。关于上传 新闻内容也是在原来的新闻内容基础上，先查看是否有相同的内容，符 合上传条件后再上传内容。
3.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。 1.添加新闻功能表
5.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。
程序名称 新建后台管理
相关数据 库表
admin,column1,column2
输入
要更新的目录
输出
更新后的目录
程序处理 ① 调用方法（创建本窗体）。
说明
② 当向数据库中存入新的目录信息时，是否超出 超出管理员的权限范围.
3.8接口
该模块与主模块及其他模块的关系如下： 1．该模块直接被主模块调用，添加、修改、删除新闻内容和文件上 传,同时进行超连接。 2．该模块直接调用数据库连接模块，取得数据库连接。
3.9存储分配
无特殊要求。
3.10注释设计
1．加在程序单元首部，说明本程序的作用。 2．对程序中的变量代表的意思、范围进行注释。 3．对程序中的函数或过程所起的作用进行注释。
4.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的 逻辑流程。
前台阅读模块会员注册部分的逻辑流程图 （重新）注册会员注册 是否符合注册条件 确定 是否提交 写入数据库 Y Y N N
4.8接口
该模块与主模块及其他模块的关系： a．该模块直接调用数据库连接模块，取得数据库的连接。 b．该模块可以直接被主模块调用生成相应的窗体。
5.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的 逻辑流程。
后台管理模块评论部分的逻辑流程图
输入管理员用户名和密码 是否有权限登录数据库 登录数据库 添加目录
修改目录 删除目录 Y Y N
5.8接口
该模块与主模块及其他模块的关系： 管理员登入和分类管理模块直接调用数据库连接模块，取得数据库 的连接。
5.9存储分配
无特殊要求。
5.10注释设计
说明准备在本程序中安排的注释 e． 加在模块首部的注释； f． 加在各分枝点处的注释； g． 对各变量的功能、范围、缺省条件等所加的注释；
5.11限制条件
a．在管理员登入模块中，管理员的权限不允许为空，登入密码不能 为空。
b．在数据库中设置管理员登入密码时必须有字长的限制。
4.3性能
本模块对程序性能没有特殊的要求。
4.4输人项
本模块只有会员注册模块有输入项，输入项是用户的注册。其他的 模块只是通过点击就可以进入相应的界面。
4.5输出项
输出项是读者通过点击所得到的相应的界面，包括：新闻的首页， 搜索新闻，新闻详情和会员注册。
4.6算法
本模块只有网页的设计，没有涉及到特殊的算法。
5.3性能
本模块对程序性能没有特殊的要求。
5.4输人项
本模块在管理员登入时需要输入帐号密码，在添加目录时需要输入 添加的新目录。在修改删除目录时，用户点击相应界面即可。
5.5输出项
输出项是管理员通过点击所得到的相应的界面，包括：登入成功， 目录添加修改删除成功。
5.6算法
本模块只有网页的设计，没有涉及到特殊的算法。
用户可管理的主要功能为新闻浏览，查看新闻， 查询新闻以及对其新闻的评价。管理者可管理的主 要功能有管理员登录，维护系统信息，维护一级栏 目信息，维护二级栏目信息以及其下的新闻信息。
1.3 参考资料
用到的参考资料： a. 校园新闻发布系统需求说明书 b. JSP网站开发详解 电子工业出版社 c. 新闻发布系统的设计与实现 发表于2008年 9月15号 d. UML系统建模与分析设计 机械工业出版 社
新闻管理 修改新闻 删除新闻 添加新闻 图1 新闻管理层次结构图
图2 前台阅读模块 前台阅读模块
搜索新闻 新闻详情 会员注册 新闻首页
图3 后台管理模块
3程序1（标识符）设计说明
本程序设计说明中以“新闻发布系统”的数据库及存储过程模块进行 详细设计为例说明如何书写程序设计说明。
3.1程序描述
“新闻发布系统”用于组建一个新的新闻发布管理，包括客户端和服 务端，以及各种新闻的管理，包括新闻内容的发布，修改和删除。
网络发展前景无限，及早与网络结合，与信息 时代同步，与高科技汇合，定会给社会各行各业的 发展注入新鲜的活力。
1.2背景 本软件系统叫新闻发布系统，系统开发的总体
任务是实现新闻的自动发布，新闻和用户信息的管 理，栏目管理。新闻发布系统是针对我们平时在阅 读新闻的不便之处而提出的。阅读新闻用户不是主 动的，不能发布自己的作品。
在设计新闻发布过程中，为了便于对新闻发布管理系统的测试，一 般首先设计好新闻发布部分，以便可以向数据库中录入部分新闻数据， 从而可以设计调试显示新闻列表和浏览新闻部分功能，在发布新闻时， 要选好新闻的类型，然后再发布上去。
在添加新闻过程中难免会出现错误，修改新闻是非常重要的。实现 修改功能的过程一般是首先将指定的内容从数据库中读取出来，然后显 示在页面的输入框中，然后再进行修改。
3.13尚未解决的问题
本程序的设计中暂时没有尚未解决而设计者认为在软件完成之前应 解决的问题。
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解 决的问题。
4程序2（标识符）设计说明
4.1程序描述
前台阅读模块的最终目的是能方便地让用户读取到新闻,设计一个界 面友好及能及时显示用户最需要信息的首页是在设计新闻发布系统时需 要着重考虑的.在新闻首页,一般将最热门信息和最新信息放置在最显眼 的位置,并提供栏目导航,使用户能随意方便地进入需要的栏目,并能看 到栏目的新闻列表内容.为了使新闻阅读具有趣味性和交互性,需要为新 闻添加发表意见添加评论的支持.新闻评论添加后会跳转到新闻详情页 面,在此页面读者可以看到新闻评论列表内容,评论附加在新闻详细内容 后面.
b．如果出现点击相应模块无法打开相应的界面，则是数据连接的原 因。如果是则满足条件。
5ຫໍສະໝຸດ Baidu序3设计说明
5.1程序描述
后台管理模块是是如何对栏目和新闻进行添加﹑审核﹑修改﹑删 除。,针对系统管理员,总结出如下需求信息: 1. 管理员有不同的权限。2. 管理员可以对栏目进行增﹑删﹑该。3. 管理员可以对新闻进行增﹑删﹑ 该。4. 管理员可以对行文模板进行增﹑删﹑改。5. 管理员可以对新闻进 行审核。6. 管理员可以对用户进行管理。
4.9存储分配
无特殊要求。
4.10注释设计
说明准备在本程序中安排的注释 a． 加在模块首部的注释； b． 加在各分枝点处的注释； c． 对各变量的功能、范围、缺省条件等所加的注释； d． 对使用的逻辑所加的注释等等。
4.11限制条件
本模块无特殊的限制条件。
4.12测试计划
a．发表评论的字数不能超过相应的数字，如果超过了所发表的评论 将无法提交，并弹出”超过所限字数”提示的窗体。如果是则满足条件。
3.3输人项
1．新闻标号代码：字符类型 2．新闻名称代码：字符类型 3．上传时间代码：datatime(8) 4．所属栏目：整型 5．文件内容：文档类型 6．所属新闻：整型 7．文件路径：varchar(100) 8．查看次数：整型
3.5输出项
添加新闻成功；修改新闻成功，删除新闻成功.
3.6算法
本程序中没有采用特殊的算法。
4程序2（标识符）设计说明 4
5 程序2（标识符）设计说 明 …………………………………………………………14
详细设计说明书
1引言
1.1编写目的
现在的世界蕴涵着相当大的信息量，每天的信息 搜集，发布和更新都需要投入很大的人力物力。在 网络发展的新时代，越来越多的信息在网上发布， 新闻最为信息的一个重要主题也不例外。这么大的 信息量，如果单纯用静态网页一个一个地制作，不 仅耗费人力物力，而且新闻本身的时效性也难以发 挥出来。所以动态新闻发布及管理系统的产生顺应 当前形势的发展，不仅节省人力物力，而且更加体 现了新闻本身的时效性。
新闻发布系统
1引言 2
1.1编写目的 2 1.2背景 2 1.3定义 2 1.4参考资料 2
2程序系统的结构 5
3程序1（标识符）设计说明 7
3.1程序描述 3 3.2功能 3 3.3性能 3 3.4输人项 3 3.5输出项 3 3.6算法 3 3.7流程逻辑 3 3.8接口 3 3.9存储分配 4 3.10注释设计 4 3.11限制条件 4 3.12测试计划 4 3.13尚未解决的问题 4
程序名称
添加新闻
相关数据库表 news
输入
查找需要添加的新闻类型
输出
查找类型成功并添加新闻
程序处理 说明
① 调用方法（创建本窗体）。 ② 在数据库中查询所想添加的新闻类型 ③ 在数据库中查到该信息后添加它。
2．修改新闻功能表
程序名称
修改新闻
相关数据库表 news
输入
查找需要修改的新闻
输出
查找新闻成功并修改
4.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。
程序名称
新建前台阅读
相关数据库表
输入
会员注册
输出
新闻详情,阅读评论
程序处理 说明
① 调用方法（创建本窗体）。 ② 当向数据库中存入新的新闻信息时，检 查评论的内容是否超出所给的最大范围. ③ 向数据库中插入新的新闻评论信息。
3.11限制条件
本程序运行暂时未限制条件。
3.12测试计划
1．若没有要添加新闻的类型时，则在分类管理子模块中添加类型。 若是，则满足要求。
2．若查找新闻为空，则提示“无此新闻”。若是，则满足要求。 3．若上传文件地址错误时，则提示“文件地址错误”。若是，则满 足要求。 4．出现写数据库错误，则提示无法连接的具体原因。若是，则满足 要求。
3.7流程逻辑
1．添加新闻流程图：
查看所添加新闻的类型 添加类型 是否存在此类型
添加新闻 N Y
保存新闻 退出操作
图A 添加新闻流程图
2．修改新闻流程图：
查找要修改的新闻 修改新闻
是否存在此新闻 退出操作
3．删除新闻流程图：
图B 修改新闻流程图
查找要删除的新闻 删除新闻
是否存在此新闻 退出操作
图C 删除新闻流程图
2程序系统的结构
功能需求与程序的关系如表2.1所示。
表2.1 功能需求与程序的关系
功能需求
程序层次结构
管理员登陆
图3
添加目录
图3
修改目录
图3
删除目录
图3
添加新闻
图1
修改新闻
图1
删除新闻
图1
新闻首页
图2
搜索新闻
图2
新闻详情
图2
会员注册
图2
后台登录
图2
News Management Unit Renew News Unit Delete News Unit Add News Unit
程序处理 说明
① 调用方法（创建本窗体）。 ② 在数据库中查询所想修改的新闻信息 ③ 在数据库中查到该信息后修改。
3．删除新闻功能表 程序名称
删除新闻
相关数据库表 输入 输出
程序处理 说明
news 查找需要删除的新闻 查找数据成功并删除 ① 调用方法（创建本窗体）。 ② 在数据库中查询所想删除的新闻信息 ③ 在数据库中查到该信息后删除它。
a．若新建管理员时密码长度长度超过限制字长，则提示“密码必须 小于指定字长”，若没超过则满足要求。
b．若新建的管理员帐号为空，则提示“请重新输入帐号的名称”若 是则满足要求。
c. 若新建的管理员帐号与数据库中已有的管理员帐号重复，则提 示“请重新输入帐号的名称”。若是，则满足要求。 d. 出现写数据库错误，则提示无法连接的具体原因。若是，则满足要 求。
删除一个新闻信息的第一步，只有当查找到合理的所需删除的新闻
内容，才可以建立其隶属的关系，然后再删除录入新闻消息。关于上传 新闻内容也是在原来的新闻内容基础上，先查看是否有相同的内容，符 合上传条件后再上传内容。
3.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。 1.添加新闻功能表
5.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。
程序名称 新建后台管理
相关数据 库表
admin,column1,column2
输入
要更新的目录
输出
更新后的目录
程序处理 ① 调用方法（创建本窗体）。
说明
② 当向数据库中存入新的目录信息时，是否超出 超出管理员的权限范围.
3.8接口
该模块与主模块及其他模块的关系如下： 1．该模块直接被主模块调用，添加、修改、删除新闻内容和文件上 传,同时进行超连接。 2．该模块直接调用数据库连接模块，取得数据库连接。
3.9存储分配
无特殊要求。
3.10注释设计
1．加在程序单元首部，说明本程序的作用。 2．对程序中的变量代表的意思、范围进行注释。 3．对程序中的函数或过程所起的作用进行注释。
4.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的 逻辑流程。
前台阅读模块会员注册部分的逻辑流程图 （重新）注册会员注册 是否符合注册条件 确定 是否提交 写入数据库 Y Y N N
4.8接口
该模块与主模块及其他模块的关系： a．该模块直接调用数据库连接模块，取得数据库的连接。 b．该模块可以直接被主模块调用生成相应的窗体。
5.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的 逻辑流程。
后台管理模块评论部分的逻辑流程图
输入管理员用户名和密码 是否有权限登录数据库 登录数据库 添加目录
修改目录 删除目录 Y Y N
5.8接口
该模块与主模块及其他模块的关系： 管理员登入和分类管理模块直接调用数据库连接模块，取得数据库 的连接。
5.9存储分配
无特殊要求。
5.10注释设计
说明准备在本程序中安排的注释 e． 加在模块首部的注释； f． 加在各分枝点处的注释； g． 对各变量的功能、范围、缺省条件等所加的注释；
5.11限制条件
a．在管理员登入模块中，管理员的权限不允许为空，登入密码不能 为空。
b．在数据库中设置管理员登入密码时必须有字长的限制。
4.3性能
本模块对程序性能没有特殊的要求。
4.4输人项
本模块只有会员注册模块有输入项，输入项是用户的注册。其他的 模块只是通过点击就可以进入相应的界面。
4.5输出项
输出项是读者通过点击所得到的相应的界面，包括：新闻的首页， 搜索新闻，新闻详情和会员注册。
4.6算法
本模块只有网页的设计，没有涉及到特殊的算法。
5.3性能
本模块对程序性能没有特殊的要求。
5.4输人项
本模块在管理员登入时需要输入帐号密码，在添加目录时需要输入 添加的新目录。在修改删除目录时，用户点击相应界面即可。
5.5输出项
输出项是管理员通过点击所得到的相应的界面，包括：登入成功， 目录添加修改删除成功。
5.6算法
本模块只有网页的设计，没有涉及到特殊的算法。
用户可管理的主要功能为新闻浏览，查看新闻， 查询新闻以及对其新闻的评价。管理者可管理的主 要功能有管理员登录，维护系统信息，维护一级栏 目信息，维护二级栏目信息以及其下的新闻信息。
1.3 参考资料
用到的参考资料： a. 校园新闻发布系统需求说明书 b. JSP网站开发详解 电子工业出版社 c. 新闻发布系统的设计与实现 发表于2008年 9月15号 d. UML系统建模与分析设计 机械工业出版 社
新闻管理 修改新闻 删除新闻 添加新闻 图1 新闻管理层次结构图
图2 前台阅读模块 前台阅读模块
搜索新闻 新闻详情 会员注册 新闻首页
图3 后台管理模块
3程序1（标识符）设计说明
本程序设计说明中以“新闻发布系统”的数据库及存储过程模块进行 详细设计为例说明如何书写程序设计说明。
3.1程序描述
“新闻发布系统”用于组建一个新的新闻发布管理，包括客户端和服 务端，以及各种新闻的管理，包括新闻内容的发布，修改和删除。
网络发展前景无限，及早与网络结合，与信息 时代同步，与高科技汇合，定会给社会各行各业的 发展注入新鲜的活力。
1.2背景 本软件系统叫新闻发布系统，系统开发的总体
任务是实现新闻的自动发布，新闻和用户信息的管 理，栏目管理。新闻发布系统是针对我们平时在阅 读新闻的不便之处而提出的。阅读新闻用户不是主 动的，不能发布自己的作品。
在设计新闻发布过程中，为了便于对新闻发布管理系统的测试，一 般首先设计好新闻发布部分，以便可以向数据库中录入部分新闻数据， 从而可以设计调试显示新闻列表和浏览新闻部分功能，在发布新闻时， 要选好新闻的类型，然后再发布上去。
在添加新闻过程中难免会出现错误，修改新闻是非常重要的。实现 修改功能的过程一般是首先将指定的内容从数据库中读取出来，然后显 示在页面的输入框中，然后再进行修改。
3.13尚未解决的问题
本程序的设计中暂时没有尚未解决而设计者认为在软件完成之前应 解决的问题。
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解 决的问题。
4程序2（标识符）设计说明
4.1程序描述
前台阅读模块的最终目的是能方便地让用户读取到新闻,设计一个界 面友好及能及时显示用户最需要信息的首页是在设计新闻发布系统时需 要着重考虑的.在新闻首页,一般将最热门信息和最新信息放置在最显眼 的位置,并提供栏目导航,使用户能随意方便地进入需要的栏目,并能看 到栏目的新闻列表内容.为了使新闻阅读具有趣味性和交互性,需要为新 闻添加发表意见添加评论的支持.新闻评论添加后会跳转到新闻详情页 面,在此页面读者可以看到新闻评论列表内容,评论附加在新闻详细内容 后面.
b．如果出现点击相应模块无法打开相应的界面，则是数据连接的原 因。如果是则满足条件。
5ຫໍສະໝຸດ Baidu序3设计说明
5.1程序描述
后台管理模块是是如何对栏目和新闻进行添加﹑审核﹑修改﹑删 除。,针对系统管理员,总结出如下需求信息: 1. 管理员有不同的权限。2. 管理员可以对栏目进行增﹑删﹑该。3. 管理员可以对新闻进行增﹑删﹑ 该。4. 管理员可以对行文模板进行增﹑删﹑改。5. 管理员可以对新闻进 行审核。6. 管理员可以对用户进行管理。
4.9存储分配
无特殊要求。
4.10注释设计
说明准备在本程序中安排的注释 a． 加在模块首部的注释； b． 加在各分枝点处的注释； c． 对各变量的功能、范围、缺省条件等所加的注释； d． 对使用的逻辑所加的注释等等。
4.11限制条件
本模块无特殊的限制条件。
4.12测试计划
a．发表评论的字数不能超过相应的数字，如果超过了所发表的评论 将无法提交，并弹出”超过所限字数”提示的窗体。如果是则满足条件。
3.3输人项
1．新闻标号代码：字符类型 2．新闻名称代码：字符类型 3．上传时间代码：datatime(8) 4．所属栏目：整型 5．文件内容：文档类型 6．所属新闻：整型 7．文件路径：varchar(100) 8．查看次数：整型
3.5输出项
添加新闻成功；修改新闻成功，删除新闻成功.
3.6算法
本程序中没有采用特殊的算法。
4程序2（标识符）设计说明 4
5 程序2（标识符）设计说 明 …………………………………………………………14
详细设计说明书
1引言
1.1编写目的
现在的世界蕴涵着相当大的信息量，每天的信息 搜集，发布和更新都需要投入很大的人力物力。在 网络发展的新时代，越来越多的信息在网上发布， 新闻最为信息的一个重要主题也不例外。这么大的 信息量，如果单纯用静态网页一个一个地制作，不 仅耗费人力物力，而且新闻本身的时效性也难以发 挥出来。所以动态新闻发布及管理系统的产生顺应 当前形势的发展，不仅节省人力物力，而且更加体 现了新闻本身的时效性。
新闻发布系统
1引言 2
1.1编写目的 2 1.2背景 2 1.3定义 2 1.4参考资料 2
2程序系统的结构 5
3程序1（标识符）设计说明 7
3.1程序描述 3 3.2功能 3 3.3性能 3 3.4输人项 3 3.5输出项 3 3.6算法 3 3.7流程逻辑 3 3.8接口 3 3.9存储分配 4 3.10注释设计 4 3.11限制条件 4 3.12测试计划 4 3.13尚未解决的问题 4
程序名称
添加新闻
相关数据库表 news
输入
查找需要添加的新闻类型
输出
查找类型成功并添加新闻
程序处理 说明
① 调用方法（创建本窗体）。 ② 在数据库中查询所想添加的新闻类型 ③ 在数据库中查到该信息后添加它。
2．修改新闻功能表
程序名称
修改新闻
相关数据库表 news
输入
查找需要修改的新闻
输出
查找新闻成功并修改
4.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图） 的形式。
程序名称
新建前台阅读
相关数据库表
输入
会员注册
输出
新闻详情,阅读评论
程序处理 说明
① 调用方法（创建本窗体）。 ② 当向数据库中存入新的新闻信息时，检 查评论的内容是否超出所给的最大范围. ③ 向数据库中插入新的新闻评论信息。
3.11限制条件
本程序运行暂时未限制条件。
3.12测试计划
1．若没有要添加新闻的类型时，则在分类管理子模块中添加类型。 若是，则满足要求。
2．若查找新闻为空，则提示“无此新闻”。若是，则满足要求。 3．若上传文件地址错误时，则提示“文件地址错误”。若是，则满 足要求。 4．出现写数据库错误，则提示无法连接的具体原因。若是，则满足 要求。
3.7流程逻辑
1．添加新闻流程图：
查看所添加新闻的类型 添加类型 是否存在此类型
添加新闻 N Y
保存新闻 退出操作
图A 添加新闻流程图
2．修改新闻流程图：
查找要修改的新闻 修改新闻
是否存在此新闻 退出操作
3．删除新闻流程图：
图B 修改新闻流程图
查找要删除的新闻 删除新闻
是否存在此新闻 退出操作
图C 删除新闻流程图
2程序系统的结构
功能需求与程序的关系如表2.1所示。
表2.1 功能需求与程序的关系
功能需求
程序层次结构
管理员登陆
图3
添加目录
图3
修改目录
图3
删除目录
图3
添加新闻
图1
修改新闻
图1
删除新闻
图1
新闻首页
图2
搜索新闻
图2
新闻详情
图2
会员注册
图2
后台登录
图2
News Management Unit Renew News Unit Delete News Unit Add News Unit
程序处理 说明
① 调用方法（创建本窗体）。 ② 在数据库中查询所想修改的新闻信息 ③ 在数据库中查到该信息后修改。
3．删除新闻功能表 程序名称
删除新闻
相关数据库表 输入 输出
程序处理 说明
news 查找需要删除的新闻 查找数据成功并删除 ① 调用方法（创建本窗体）。 ② 在数据库中查询所想删除的新闻信息 ③ 在数据库中查到该信息后删除它。