网站软件设计说明书

1、网站软件 （结构）设计说明书 一引言 1引言 本说明书为系统的结构设计说明书， 为系统详细的设计的主要依据。 主要读者群为项目组成员， 使 得项目组内成员对整个系统的主要功能以及其概要的实现手段,有一个宏观的把握， 是整个系统最初形， 同时也是最基本的引导性文档 （软件体系结构设计说明书 ），将从设计的角度对系统进行综合的描述，使 用不同的视图来描述其不同方面。 在本说明书中， 将对该说明书的结构进行简要的说明， 明确该说明书 针对的读者群 ,指导他们正确的使用该说明书。 预期的读者： 本说明书是软件体系结构设计的说明书， 主要读者群为项目组成员， 其次供公司上层 （老师 ）评审，并指导开发人

2、员的开发。 2背景 1）项目名称：山桐子能源科技有限责任公司 2）项目任务提出者 :张林鹏 3）项目负责人：胡芸儿 4）开发者：赵霞、杨露、陈其瑜、冯明华、张林鹏、胡芸儿 5）开发工具： Dreamweaver8、asp .net 技术、PS 技术、SQL server 2000 6）运行平台：本项目采用 WINDOW 2000 为操作系统 7） 适用用户：所有能上网浏览网页的用户,主要用户是需要山桐子的人群 . 3定义 1） 该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。 还有一种可简明的做法， 就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。 2）比如

3、：dl:登录、zc:注册、gssy:公司首页、cpzs:产品展示、gsshow:公司相册、zxly:在线留言、news: 新闻中心、aboutus:关于我们、zpxx:招聘信息、kjwx:科技文献、cyjs:产业介绍。 4参考资料 （1）本项目的经核准的计划任务书或合同、上级机关的批文； （2）属于本项目的其他已发表的文件：山桐子网站需求说明书、山桐子网站设计标准规范说明书、 网站发展的调查与分析、网站存储目录及切片对象要求说明书、网站的技术和工具的说明或分析 （3）本文件中各处引用到的文件资料： 1 陈元国需求分析说明书参考资料书， 2013.4 2 顾正刚网站规划与建设机械工业出版社， 2

4、010.2 3 张强数据库设计说明书参考资料书， 2013.5 二模块 /程序系统的组织结构 根据“需求分析说明书”的功能表及流程图，设计系统功能模块间的组织结构。 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说 明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系 模板编辑 会员管理 用户管理 人员管理 技术人员 栏目管理 生成静态页 新闻发布 网站管理系统 编辑管理 首页 添加模块 修改模板 删除模板 添加新闻 修改新闻 删除新闻 三网站前、后台各子模块功能间的功能描述及示意图 模板列表 管理人员 销售人员 基于网站整体结构组织图基

5、础上，实现前、后台模块功能的功能描述、设计思路、示意图 1新闻中心 1 ）功能描述 展示相关新闻，通过新闻让浏览者了解更多相关信息。 2）设计思路 前台：即用户端浏览器，实现查看新闻功能（查看新闻及其相关内容） 后台：即管理端浏览器，实现新闻管理功能（上传新闻、编辑、删除新闻） 3）新闻中心模块示意图 用户端浏览器 管理端浏览器 显示公司新闻 管理新闻 显示公司公告 上传新闻 显示行业新闻 编辑新闻 删除新闻 2招聘信息 1 ）功能描述 通过招聘信息让浏览者了解公司需要招聘哪些人才。 2）设计思路 前台：即用户端浏览器，实现查看招聘信息功能（查看招聘条件） 后台：即管理端浏览器，实现招聘信息管

6、理功能（统计报名人数，显示报名用户的基本资料） 3）招聘信息模块示意图 用户端浏览器 管理端浏览器 显示招聘信息 管理招聘信息 显示招聘岗位 F 统计应聘人数 显示招聘要求 审核应聘者基本 信息 3. 在线留言模块 1 ）功能描述 通过在线留言，快速有效地收集用户的意见及建议。 2）设计思路 前台：即用户端浏览器，实现在线留言功能（用户填写并提交留言、查看留言） 后台：即管理端浏览器，实现在线留言管理功能（显示留言、回复、删除留言） 3）在线留言模块示意 用户端浏览器 管理端浏览器 在线留言 管理在线留言 填写留言 审核留言信息 IP- 提交留言内容 管理留言信息 浏览所留言信息 4. 产品介

7、绍 1 ）功能描述 通过产品介绍，让浏览者了解产品的相关信息。 2）设计思路 前台：即用户端浏览器，实现查看产品介绍功能（查看产品名称、来源、种类、功能用途等） 后台：即管理端浏览器，实现产品介绍管理功能（编辑、显示产品介绍） 3）产品介绍模块示意图 用户端浏览器 管理端浏览器 浏览产品介绍 管理产品介绍 浏览产品来源 管理产品种类来 1 源信息 浏览产品种类 管理产品功能用 浏览产品功能用 途信息 途 5. 关于我们 1 ）功能描述 通过介绍本公司，让浏览者了解本公司的发展。 2）设计思路 前台：即用户端浏览器，实现查看公司介绍功能（查看公司发展、规模、主要产品、加工技术等） 后台：即管理端

8、浏览器，实现公司介绍管理功能（编辑、显示公司介绍） 3）关于我们模块示意图 用户端浏览器 管理端浏览器 浏览产品介绍 管理产品简介 浏览公司发展 管理公司发展信息 浏览公司规模 管理公司规模信息 浏览公司产品 编辑公司产品 6、科技文献模块 1 ）功能描述 介绍公司在技术领域取得的相关成就，普及相关知识，使游客更加了解公司的产业和产品。提升公 司的人文形象，介绍公司的发展之路。 2）设计思路 前台：即用户端浏览器，实现网上查阅功能，（如查看各类文章、及下载文章等功能。） 后台：即管理端浏览器，实现文章上传功能，（如删除文章功能、文章编排功能、文章上传功能。） 3）科技文献模块示意图 用户端浏览

9、器 管理端浏览器 浏览文章内容 文章管理 浏览科技乂献 上传论文 浏览论文资料 修改文章 浏览相关业绩 文章编排 7、产品展示模块 1 ）功能描述 展示公司产品，让游客更多的了解公司产品的多样性，全面性及多功能性。 2）设计思路 前台：即用户端浏览器，浏览公司页面，浏览产品的图片、名称、及价格。 后台：即管理端浏览器，实现产品图片上传及相关文字介绍功能，编辑产品名称、编号、价格、图 3）产品展示模块示意图 用户端浏览器 浏览产品 浏览产品用途 浏览产品制造 浏览加工产品 管理端浏览器 相册管理 产品管理 产品编号 产品名称 产品图片 8、公司相册模块 1 ）功能描述 展示公司举行的活动及相关图

10、片，让游客更深入了解公司，直观的展示公司的人文气息和创造力, 让游客感受到公司的生机与活力，这是一个充满激情的团队。 2）设计思路 前台：即用户端浏览器, 浏览公司页面，浏览公司活动的照片, 时间，地点，活动主题及参与人员。 后台：即管理端浏览器, 实现活动照片上传及相关文字介绍功能, 如删除、修改活动照片及文字介 绍。 3）公司相册模块示意图 用户端浏览器 管理端浏览器 浏览活动相册 相册管理 浏览活动举行的 地点 fc- 上传照片 尸 删除照片 浏览活动时间 修改信息 浏览活动主题 活动时间 9、首页模块 1 ）功能描述 整体展示公司的产品类型包括产品图片，种类等。展示产业结构及公司规模和

11、公司的整体风貌。介 绍山桐子发展起源等全方位的向游客作一个全面的介绍。 2）设计思路 前台：即用户端浏览器，浏览公司网站，浏览产品展示、新闻中心、关于我们、公司介绍、招聘信 息、科技文献，在线留言等模块。 后台：即管理端浏览器，通过相关技术手段编辑链接网站上的其他模块。如上传修改信息内容，上 传删除图片，更新产业产品信息等，使游客可以自如的浏览公司首页。 3)首页模块示意图 用户端浏览器 管理端浏览器 显示公司首页 后台管理 显示新闻相关内 编排各模块 容 上传信息内容 发布招聘信息 查看留言等 四系统模块功能/功能模块的设计描述 根据“需求分析说明书”及“网站演示版”完成功能功能描述及设计思

12、路，详细描述与网站每一个 子模块中的基本功能模块/对象相关联的需求。 功能描述 描述此功能模块要达到的目标、 所采用的方法和技术，可采用IPO图(输入一处理一输出图)的形式。 输入 (1) 详细描述该功能的所有输入数据，女口：输入源、数量、度量单位、时间设定和有效输入范围等。 (2) 指明引用的接口说明或接口控制文件的参考资料。 处理 (1) 定义对输入数据、中间参数进行处理以获得预期输出结果的全部操作。包括： (2) 输入数据的有效性检查(名称、标识、数据类型及格式、有效范围、输入形式)。 (3) 操作的顺序，包括事件的时间设定。 (4) 异常情况的响应，例如，溢出、通信故障、错误处理、影响

13、的参数等。 (5) 用于把输入转换成相应输出的方法。 输出 (1) 输出数据的有效性检查(名称、标识、数据类型及格式、有效范围、输出形式)。 (2) 详细说明该功能的所有输出数据，例如，输出目的地、数量、度量单位、时间关系、有效输(1) 出范围、非法值的处理、出错信息等。 (3) 有关接口说明或接口控制文件的参考资料(录属的上一层模块及下一层模块或程序，说明参数 赋值及调用式)。 1会员登录模块 功能模块 会员用户登录 所属部门 账户管理部 开发人 赵霞 名 门员 功能描述 （目的） 输入用户名及密码，经过验证并通过，会员登录后，做为会员便可行驶会员专属的权 利 使用者 普通游客、会员、管理员

14、/超级管理员 需求程序 A 技术 前置条件 （限制条 件） 会员用户必须先注册成功后成为会员用户后才能成功 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 用户名和密码 输入项检 查 根据输入用户名和密码通过后台程序dl及其数据库进行验证，查找是否是会员用户 及正确的密码 操作序列 （算法或者 处理描述 逻辑流程） 1. 通过登录界面输入用户名及密码，点击“登录”按钮； 2. 调用后台程序dl，运用dl方法在数据库中进行查找验证用户名和密码； 3. 若找到用户名并且密码也正确则成功登录，否则弹出提示框“用户名或密码不正确， 请重新输入！，并回到登录界面； 4. 成功登录后提示“登录

15、成功”，进入到首页界面，用户可以进行关于我们，产品展 示，产品介绍，公司相册，新闻中心，招聘信息，科技文献，在线留言的浏览。 异常/出 错 情况及处 理 1. 用户名或密码不正确，请重新输入！则回到登录界面，并提示用户重新登录 2. 当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出” 后置条件 无 预期结果 用户名和密码不正确，则不能登录，若正确则成功登录。 输出项检 查 是否出现提示信息“用户名或密码不正确，请重新输入”，若成功则出现“登录成功”。 相关对象 及接口 首页：用于输入用户名和密码 补充说明 （注释设 计） 密码长度需要6个字符以上。 测试计划 对模块进行测试的计划

16、 L :测试技术要求、输入数据、预期结果、进度安排、人员职 责 2 关于我们模块 功能模块 关于我们 所属部 公司编辑 开发人 张林鹏 名 门部门员 功能描述 （目的） 向浏览者详细介绍的我们公司的一切相关信息 使用者 普通游客、会员、管理员/超级管理员 需求程序 Aboutus 前置条件 （限制条 件） 无 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 无 输入项检 查 无 操作序列 （算法或者 处理描述 逻辑流程） 1点击“关于我们”，进入关于“关于我们”页面； 2.浏览“关于我们”的内容； 3点击“客服留言“跳转到在线留言； 异常/出 错 情况及处 理 无 后置条件 无 预

17、期结果 成功进入网站后，可以浏览本网页，否则不能浏览 输出项检 查 无 相关对象 及接口 首页：关于我们 补充说明 （注释设 计） 本模块中的信息属于公司资料，不可随意复制粘贴 测试计划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 3 .产品展示模块 功能模块 名 产业介绍 所属部 门 公司开发 部门 开发人 员 杨露 功能描述 （目的） 向浏览者详细的介绍了我公司的产品的信息，让来客更了解该产品的用途 使用者 普通游客、会员、管理员/超级管理员 需求程序 无 前置条件 （限制条 件） 无 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 无 输

18、入项检 查 无 操作序列 （算法或者 处理描述 逻辑流程） 1点击“产品展示”，浏览三种类型信息：创意概念、实体产品、其他 2点击 XXX展示，通过asp .net程序中fin d（）方法，基于产品展示类型基础上依 据时间先后顺序显示展示图片及文字（最近时间显示在最前面）； 3. 点击“图片”在新的页面显示“标题”“实体产品图片”“购买订单”等； 4. 点击“客服留言“跳转到在线留言 异常/出 错 情况及处 理 无 后置条件 无 预期结果 成功进入网站后，可以浏览本网页，否则不能浏览 输出项检 查 无 相关对象 及接口 首页：产业介绍 补充说明 （注释设 计） 本模块中的信息属于公司资料，不可

19、随意复制粘贴 测试计划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 4 .产业介绍模块 功能模块 名 产业介绍 所属部 门 公司开发 部门 开发人 员 杨露 功能描述 （目的） 向浏览者详细的介绍了我公司的产品的信息，让来客更了解该产品的用途 使用者 普通游客、会员、管理员/超级管理员 需求程序 无 前置条件 （限制条 件） 无 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 无 输入项检 查 无 操作序列 （算法或者 处理描述 逻辑流程） 1点击“产业介绍”，进入关于“产业介绍”页面； 2.浏览“产业介绍”的图片、文字信息； 3点击“客服留言

20、“跳转到在线留言 异常/出 错 情况及处 理 无 后置条件 无 预期结果 成功进入网站后，可以浏览本网页，否则不能浏览 输出项检 查 无 相关对象 及接口 首页：产业介绍 补充说明 （注释设 计） 本模块中的信息属于公司资料，不可随意复制粘贴 测试计划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 5 公司相册模块 功能模块 名 公司相册 所属部 门 公司开发 部门 开发人 员 杨露 功能描述 （目的） 向浏览者展示了我公司的公司活动的照片以及我公司实地产品相关的照片 使用者 普通游客、会员、管理员/超级管理员 需求程序 gsshow 前置条件 （限制条 件

21、） 只有管理员成功登陆才可实现相册的上传 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 需上传的相册的数据，以及对上传相册内容的描述 输入项检 查 需上传的相册是否存在 操作序列 （算法或者 处理描述 逻辑流程） 1.进入公司相册，浏览两种类型信息：山桐子相关产品、公司产品； 2点击山桐子相关产品，通过程序中find（）方法，基于招聘类型基础上 依据时间先后顺序显示公司相册内容及时间（最近时间显示在最前面）； 3. 点击“相册内容”在新的页面显示“标题”“图片”等信息； 4. 点击“客服留言“跳转到在线留言 异常/出 错 情况及处 理 相册信息有误或不存在，显示提示框“该相册不存

22、在，请重新选择！”并返回上传界 面 后置条件 无 预期结果 相册信息存在错误，则不能上传；若正确则成功上传 输出项检 查 是否出现提示信息“该相册不存在，请重新输入！”，若成功则出现“上传成功” 相关对象 及接口 首页：公司相册 补充说明 （注释设 计） 无 测试计划 对模块进行测试的计划 L :测试技术要求、输入数据、预期结果、进度安排、人员职 责 6 新闻中心模块 功能模 块名 新闻中心 所属部 门 公司编辑 部门 开发人 员 张林鹏 功能描 述 （目的） 向浏览者展示了我公司的公司新闻、公告以及行业新闻 使用 者 普通游客、会员、管理员/超级管理员 需求程 序 News 前置条 件 （限

23、制条 件） 作为管理员登陆成功后可进行新闻的上传 界面要 求 子体的大小与颜色统一，子间距与行距固疋 输入数 据 需上传的新闻的标题，以及对所上传新闻内容的详细描述与验证码 输入项 检查 需上传的新闻信息是否存在 操作序 列 （算法或者 处理描述 逻辑流程） 1.进入新闻中心，浏览三种类型新闻：公司新闻、公司公告、行业新闻； 2点击 公司新闻 新闻，通过 asp .net程序中find （）方法，基于新闻类型基础上 依据时间先后顺序显示新闻标题及时间（最近时间显示最前面）； 3. 点击“新闻标题”在新的页面显示“标题”“发布者” “发布时间” “发布内容” 等； 4. 点击“客服留言“跳转到在

24、线留言 异常/出 错 情况及 无 处理 后置条 件 无 预期结 果 新闻中心的成功浏览 输出项 检查 无 相关对 象 及接 口 首页：新闻中心 补充说 明 （注释设 计） 无 测试计 划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 7 招聘信息模块 功能模 块名 招聘信息 所属部 门 人才管理 部门 开发人 员 胡芸儿 功能描 述 （目的） 向浏览者展示了我公司的招聘相关信息，包括全职岗位、兼职岗位以及实习岗位的信 息 使用 者 普通游客、会员、管理员/超级管理员 需求程 序 A 、SQL 2005 前置条 件 （限制条 件） 无 界面要 求 子体的大小与

25、颜色统一，子间距与行距固疋 输入数 无 据 输入项 检查 无 操作序 列 （算法或者 处理描述 逻辑流程） 1.进入招聘信息，浏览三种类型招聘：全职岗位、兼职岗位、实习岗位； 2点击“XXX招聘，通过程序中find（）方法，基于招聘类型基础上依据时 间先后顺序显示招聘岗位及时间（最近时间显示在最前面）； 3. 点击“招聘岗位”在新的页面显示“标题”“职位职责”“任职资格” “应聘”等； 4. 点击“应聘”在新的页面显示“申请职位”“填写个人信息”“提交申请”等； 5. 点击“客服留言“跳转到在线留言 异常/ 出 错 情况及 处理 无 后置条 件 无 预期结 果 成功进入网站后，可以浏览本网页，

26、否则不能浏览 输出项 检查 无 相关对 象 及接 口 首页：招聘信息（zpxx） 补充说 明 （注释设 计） 本模块中的信息属于公司资料，不可随意复制粘贴 测试计 划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 8.科技文献模块 功能模块 名 科技文献 所属部 门 公司技术 部门 开发人 员 陈齐瑜 功能描述 亡t 弟【1【斤二 E1 Z #4 / =1 砧 TrFF 口 N穴必ITZ口 士口 砧 * r 砧 j/krV 在用户登录后还可对 冋浏览者展小了我公司的项目资料以及丿品相关的杰出的论文 （目的） 山桐子相关论文进行下载浏览 使用者 普通游客、会员

27、、管理员/超级管理员 需求程序 kjwx 前置条件 （限制条 件） 作为管理员登陆成功可编辑上传文章 界面要求 子体的大小与颜色统一，子间距与行距固疋 输入数据 需上传的科技文献的标题，以及文献内容及上传时间 输入项检 查 需上传的文献资料是否存在 操作序列 （算法或者 处理描述 逻辑流程） 1.进入科技文献，浏览三个类型信息：山桐子论文下载、项目资料文集、其他； 2点击某篇科技文章，通过程序中find（）方法，基于科技文献基础上依据 时间先后顺序显示文献资料（最近时间显示在最前面）； 3. 点击科技文献标题，在新的页面显示文章标题，内容、上传时间等信息。 4. 点击“客服留言“跳转到在线留言

28、 异常/出 错 情况及处 理 无 后置条件 无 预期结果 科技文献页面成功显示 输出项检 查 无 相关对象 及接口 首页：科技文献 补充说明 （注释设 计） 无 测试计划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 9 在线留言模块 功能模块 名 在线留言 所属部 门 公司咨询 部门 开发人 员 冯明华 功能描述 （目的） 输入想要表述的内容，留下留言者的联系方式，然后输入正确的验证码，就可以完成 留言 使用者 普通游客、会员、管理员/超级管理员 需求程序 A、SQL 2005 前置条件 （限制条 件） 任何人都能够在进入本模块后留言 界面要求 子体的大小

29、与颜色统一，子间距与行距固疋 输入数据 留言冋题、留言内容、联系人、验证码（必填） 联系方式、xx、sfz （任填） 输入项检 查 根据是否输入冋题与内容，输入验证码是否正确，通过后台程序LY进仃验证，确认 能否成功留言 操作序列 （算法或者 处理描述 逻辑流程） 1. 进入在线留言，显示留言信息要求，填与 留言信息； 2. “点击提交”在新的页面显示自己所留言内容； 异常/出 错 情况及处 理 1. “ *不能为空”，则回到留言界面，表示用户可以重新留言 2. “验证码不正确”，返回到留言界面，用户需重新留言 后置条件 无 预期结果 有内容未填为空和验证码不正确，则不能登录，反之则成功登录。 输出项检 查 是否出现提示信息“ *不能为空”或“验证码不正确”，若成功则出现“留言成功， 审核等待中！” 相关对象 及接口 首页：在线留言 补充说明 （注释设 计） 问题不得大于25个字符； 内容不能少于10个字符 测试计划 对模块进行测试的计划 L:测试技术要求、输入数据、预期结果、进度安排、人员职 责 10 公司首页模块 功能模块 名 公司首页 所属部 门 公司编辑 部门 开发人 员 赵霞 功能描述 （目的） 总览网站信息，会员注册登录 使用者 普通游客、会员、管理员/超级管理员 需求程序 gssy 前置条件 （限制条 件） 无 界面要求 子体的大小与颜