新闻发布系统详细设计说明书.docx

1、新闻发布系统详细设计说明书新 闻 发 布 系 统详细设计说明书 1引言 21.1编写目的 21.2背景 21.3定义 21.4参考资料 22程序系统的结构 53程序1（标识符）设计说明 73.1程序描述 33.2功能 33.3性能 33.4输人项 33.5输出项 33.6算法 33.7流程逻辑 33.8接口 33.9存储分配 43.10注释设计 43.11限制条件 43.12测试计划 43.13尚未解决的问题 44程序2（标识符）设计说明 4 5 程序2（标识符）设计说明 14 详细设计说明书1引言1.1编写目的现在的世界蕴涵着相当大的信息量，每天的信息搜集，发布和更新都需要投入很大的人力物力

2、。在网络发展的新时代，越来越多的信息在网上发布，新闻最为信息的一个重要主题也不例外。这么大的信息量，如果单纯用静态网页一个一个地制作，不仅耗费人力物力，而且新闻本身的时效性也难以发挥出来。所以动态新闻发布及管理系统的产生顺应当前形势的发展，不仅节省人力物力，而且更加体现了新闻本身的时效性。网络发展前景无限，及早与网络结合，与信息时代同步，与高科技汇合，定会给社会各行各业的发展注入新鲜的活力。1.2背景本软件系统叫新闻发布系统，系统开发的总体任务是实现新闻的自动发布，新闻和用户信息的管理，栏目管理。新闻发布系统是针对我们平时在阅读新闻的不便之处而提出的。阅读新闻用户不是主动的，不能发布自己的作品

3、。用户可管理的主要功能为新闻浏览，查看新闻，查询新闻以及对其新闻的评价。管理者可管理的主要功能有管理员登录，维护系统信息，维护一级栏目信息，维护二级栏目信息以及其下的新闻信息。1.3 参考资料用到的参考资料：a. 校园新闻发布系统需求说明书b. JSP网站开发详解 电子工业出版社c. 新闻发布系统的设计与实现 发表于2008年9月15号d. UML系统建模与分析设计 机械工业出版社2程序系统的结构功能需求与程序的关系如表2.1所示。表2.1 功能需求与程序的关系功能需求程序层次结构管理员登陆图3添加目录图3修改目录图3删除目录图3添加新闻图1修改新闻图1删除新闻图1新闻首页图2搜索新闻图2新闻

4、详情图2会员注册图2后台登录图2 图1 新闻管理层次结构图 图2 前台阅读模块图3 后台管理模块3程序1（标识符）设计说明 本程序设计说明中以“新闻发布系统”的数据库及存储过程模块进行详细设计为例说明如何书写程序设计说明。3.1程序描述“新闻发布系统”用于组建一个新的新闻发布管理，包括客户端和服务端，以及各种新闻的管理，包括新闻内容的发布，修改和删除。在设计新闻发布过程中，为了便于对新闻发布管理系统的测试，一般首先设计好新闻发布部分，以便可以向数据库中录入部分新闻数据，从而可以设计调试显示新闻列表和浏览新闻部分功能，在发布新闻时，要选好新闻的类型，然后再发布上去。在添加新闻过程中难免会出现错误

5、，修改新闻是非常重要的。实现修改功能的过程一般是首先将指定的内容从数据库中读取出来，然后显示在页面的输入框中，然后再进行修改。删除一个新闻信息的第一步，只有当查找到合理的所需删除的新闻内容，才可以建立其隶属的关系，然后再删除录入新闻消息。关于上传新闻内容也是在原来的新闻内容基础上，先查看是否有相同的内容，符合上传条件后再上传内容。3.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。1.添加新闻功能表程序名称添加新闻相关数据库表 news输入查找需要添加的新闻类型输出查找类型成功并添加新闻程序处理说明 调用方法（创建本窗体）。 在数据库中查询所想添加的新闻类型 在数据

6、库中查到该信息后添加它。2修改新闻功能表程序名称修改新闻相关数据库表news输入查找需要修改的新闻输出查找新闻成功并修改程序处理说明 调用方法（创建本窗体）。 在数据库中查询所想修改的新闻信息 在数据库中查到该信息后修改。3删除新闻功能表程序名称删除新闻相关数据库表 news输入查找需要删除的新闻输出查找数据成功并删除程序处理说明 调用方法（创建本窗体）。 在数据库中查询所想删除的新闻信息 在数据库中查到该信息后删除它。3.3输人项1新闻标号代码：字符类型2新闻名称代码：字符类型3上传时间代码：datatime(8)4所属栏目：整型5文件内容：文档类型6所属新闻：整型7文件路径：varchar

7、(100)8查看次数：整型3.5输出项添加新闻成功；修改新闻成功，删除新闻成功.3.6算法本程序中没有采用特殊的算法。3.7流程逻辑1添加新闻流程图： 图A 添加新闻流程图2修改新闻流程图：图B 修改新闻流程图3删除新闻流程图：图C 删除新闻流程图3.8接口该模块与主模块及其他模块的关系如下：1该模块直接被主模块调用，添加、修改、删除新闻内容和文件上传,同时进行超连接。2该模块直接调用数据库连接模块，取得数据库连接。3.9存储分配无特殊要求。3.10注释设计1加在程序单元首部，说明本程序的作用。2对程序中的变量代表的意思、范围进行注释。3对程序中的函数或过程所起的作用进行注释。3.11限制条件

8、本程序运行暂时未限制条件。3.12测试计划1若没有要添加新闻的类型时，则在分类管理子模块中添加类型。若是，则满足要求。2若查找新闻为空，则提示“无此新闻”。若是，则满足要求。3若上传文件地址错误时，则提示“文件地址错误”。若是，则满足要求。4出现写数据库错误，则提示无法连接的具体原因。若是，则满足要求。3.13尚未解决的问题本程序的设计中暂时没有尚未解决而设计者认为在软件完成之前应解决的问题。3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。4程序2（标识符）设计说明4.1程序描述前台阅读模块的最终目的是能方便地让用户读取到新闻,设计一个界面友好及能及时

9、显示用户最需要信息的首页是在设计新闻发布系统时需要着重考虑的.在新闻首页,一般将最热门信息和最新信息放置在最显眼的位置,并提供栏目导航,使用户能随意方便地进入需要的栏目,并能看到栏目的新闻列表内容.为了使新闻阅读具有趣味性和交互性,需要为新闻添加发表意见添加评论的支持.新闻评论添加后会跳转到新闻详情页面,在此页面读者可以看到新闻评论列表内容,评论附加在新闻详细内容后面.4.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。程序名称新建前台阅读相关数据库表输入会员注册输出新闻详情,阅读评论程序处理说明 调用方法（创建本窗体）。 当向数据库中存入新的新闻信息时，检查评论的

10、内容是否超出所给的最大范围. 向数据库中插入新的新闻评论信息。4.3性能本模块对程序性能没有特殊的要求。4.4输人项本模块只有会员注册模块有输入项，输入项是用户的注册。其他的模块只是通过点击就可以进入相应的界面。 4.5输出项输出项是读者通过点击所得到的相应的界面，包括：新闻的首页，搜索新闻，新闻详情和会员注册。4.6算法本模块只有网页的设计，没有涉及到特殊的算法。4.7流程逻辑用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。前台阅读模块会员注册部分的逻辑流程图4.8接口该模块与主模块及其他模块的关系：a该模块直接调用数据库连接模块，取得数据库的连接。b该模块可以直接被主模

11、块调用生成相应的窗体。4.9存储分配无特殊要求。4.10注释设计说明准备在本程序中安排的注释a 加在模块首部的注释；b 加在各分枝点处的注释；c 对各变量的功能、范围、缺省条件等所加的注释；d 对使用的逻辑所加的注释等等。4.11限制条件本模块无特殊的限制条件。4.12测试计划a发表评论的字数不能超过相应的数字，如果超过了所发表的评论将无法提交，并弹出”超过所限字数”提示的窗体。如果是则满足条件。b如果出现点击相应模块无法打开相应的界面，则是数据连接的原因。如果是则满足条件。5程序3设计说明5.1程序描述后台管理模块是是如何对栏目和新闻进行添加审核修改删除。,针对系统管理员,总结出如下需求信息

12、: 1. 管理员有不同的权限。2. 管理员可以对栏目进行增删该。3. 管理员可以对新闻进行增删该。4. 管理员可以对行文模板进行增删改。5. 管理员可以对新闻进行审核。6. 管理员可以对用户进行管理。5.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。程序名称新建后台管理相关数据库表admin,column1,column2输入要更新的目录输出更新后的目录程序处理说明 调用方法（创建本窗体）。 当向数据库中存入新的目录信息时，是否超出超出管理员的权限范围.5.3性能本模块对程序性能没有特殊的要求。5.4输人项本模块在管理员登入时需要输入帐号密码，在添加目录时需要输入

13、添加的新目录。在修改删除目录时，用户点击相应界面即可。5.5输出项输出项是管理员通过点击所得到的相应的界面，包括：登入成功，目录添加修改删除成功。5.6算法本模块只有网页的设计，没有涉及到特殊的算法。5.7流程逻辑用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。后台管理模块评论部分的逻辑流程图5.8接口该模块与主模块及其他模块的关系：管理员登入和分类管理模块直接调用数据库连接模块，取得数据库的连接。5.9存储分配无特殊要求。5.10注释设计说明准备在本程序中安排的注释e 加在模块首部的注释；f 加在各分枝点处的注释；g 对各变量的功能、范围、缺省条件等所加的注释；5.11限制条件a在管理员登入模块中，管理员的权限不允许为空，登入密码不能为空。b在数据库中设置管理员登入密码时必须有字长的限制。5.12测试计划a若新建管理员时密码长度长度超过限制字长，则提示“密码必须小于指定字长”，若没超过则满足要求。b若新建的管理员帐号为空，则提示“请重新输入帐号的名称”若是则满足要求。c. 若新建的管理员帐号与数据库中已有的管理员帐号重复，则提示“请重新输入帐号的名称”。若是，则满足要求。d. 出现写数据库错误，则提示无法连接的具体原因。若是，则满足要求。