网站软件(结构)设计说明书.doc

(完整word版)网站软件(结构)设计说明书网站软件(结构)设计说明书一引言1引言本说明书为系统的结构设计说明书，为系统详细的设计的主要依据。主要读者群为项目组成员，使得项目组内成员对整个系统的主要功能以及其概要的实现手段,有一个宏观的把握，是整个系统最初形，同时也是最基本的引导性文档(软件体系结构设计说明书)，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本说明书中，将对该说明书的结构进行简要的说明，明确该说明书针对的读者群,指导他们正确的使用该说明书。预期的读者：本说明书是软件体系结构设计的说明书，主要读者群为项目组成员，其次供公司上层(老师)评审，并指导开发人员的开发。2背景1）项目名称：山桐子能源科技有限责任公司2）项目任务提出者:张林鹏3）项目负责人：胡芸儿4）开发者：赵霞、杨露、陈其瑜、冯明华、张林鹏、胡芸儿5）开发工具：Dreamweaver8、技术、PS技术、SQL server 20006）运行平台：本项目采用WINDOW 2000为操作系统7）适用用户：所有能上网浏览网页的用户,主要用户是需要山桐子的人群.3定义1）该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。2）比如:dl:登录、zc:注册、gssy:公司首页、cpzs:产品展示、gsshow:公司相册、zxly:在线留言、news:新闻中心、aboutus:关于我们、zpxx:招聘信息、kjwx:科技文献、cyjs:产业介绍。4参考资料 (1) 本项目的经核准的计划任务书或合同、上级机关的批文；(2) 属于本项目的其他已发表的文件：山桐子网站需求说明书、山桐子网站设计标准规范说明书 、网站发展的调查与分析、网站存储目录及切片对象要求说明书、网站的技术和工具的说明或分析(3)本文件中各处引用到的文件资料： 1 陈元国需求分析说明书参考资料书，2013.42 顾正刚网站规划与建设机械工业出版社，2010.23 张强数据库设计说明书参考资料书，2013.5二模块/程序系统的组织结构根据“需求分析说明书”的功能表及流程图，设计系统功能模块间的组织结构。用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.网站管理系统编辑管理栏目管理新闻发布招聘信息公司相册产品展示新闻中心首页生成静态页面删除新闻添加新闻修改新闻用户管理技术人员会员管理人员管理管理人员销售人员模板编辑模板列表删除模板修改模板添加模板增加模块产业介绍科技文献关于我们在线留言三网站前、后台各子模块功能间的功能描述及示意图基于网站整体结构组织图基础上，实现前、后台模块功能的功能描述、设计思路、示意图.1.新闻中心1）功能描述展示相关新闻，通过新闻让浏览者了解更多相关信息。2）设计思路前台：即用户端浏览器，实现查看新闻功能（查看新闻及其相关内容）后台：即管理端浏览器，实现新闻管理功能（上传新闻、编辑、删除新闻）3）新闻中心模块示意图 用户端浏览器显示公司新闻显示公司公告显示行业新闻管理端浏览器管理新闻上传新闻编辑新闻删除新闻2.招聘信息1）功能描述通过招聘信息让浏览者了解公司需要招聘哪些人才。2）设计思路前台：即用户端浏览器，实现查看招聘信息功能（查看招聘条件）后台：即管理端浏览器，实现招聘信息管理功能（统计报名人数，显示报名用户的基本资料）3）招聘信息模块示意图 用户端浏览器显示招聘信息显示招聘岗位显示招聘要求管理端浏览器管理招聘信息统计应聘人数审核应聘者基本信息3.在线留言模块1）功能描述通过在线留言，快速有效地收集用户的意见及建议。2）设计思路前台：即用户端浏览器，实现在线留言功能（用户填写并提交留言、查看留言）后台：即管理端浏览器，实现在线留言管理功能（显示留言、回复、删除留言）3）在线留言模块示意用户端浏览器在线留言填写留言提交留言内容浏览所留言信息管理端浏览器管理在线留言审核留言信息管理留言信息4产品介绍1）功能描述通过产品介绍，让浏览者了解产品的相关信息。2）设计思路前台：即用户端浏览器，实现查看产品介绍功能（查看产品名称、来源、种类、功能用途等）后台：即管理端浏览器，实现产品介绍管理功能（编辑、显示产品介绍）3）产品介绍模块示意图用户端浏览器浏览产品介绍浏览产品来源浏览产品种类浏览产品功能用途管理端浏览器管理产品介绍管理产品种类来源信息管理产品功能用途信息信息编辑公司简介5关于我们1）功能描述通过介绍本公司，让浏览者了解本公司的发展。2）设计思路前台：即用户端浏览器，实现查看公司介绍功能（查看公司发展、规模、主要产品、加工技术等）后台：即管理端浏览器，实现公司介绍管理功能（编辑、显示公司介绍）3）关于我们模块示意图用户端浏览器浏览产品介绍浏览公司发展浏览公司规模浏览公司产品管理端浏览器管理产品简介管理公司发展信息管理公司规模信息编辑公司产品6、科技文献模块1）功能描述介绍公司在技术领域取得的相关成就，普及相关知识，使游客更加了解公司的产业和产品。提升公司的人文形象，介绍公司的发展之路。2）设计思路前台：即用户端浏览器，实现网上查阅功能，（如查看各类文章、及下载文章等功能。）后台：即管理端浏览器，实现文章上传功能，（如删除文章功能、文章编排功能、文章上传功能。）3）科技文献模块示意图用户端浏览器浏览文章内容浏览科技文献浏览论文资料浏览相关业绩管理端浏览器文章管理上传论文修改文章文章编排公司业绩7、产品展示模块1）功能描述展示公司产品，让游客更多的了解公司产品的多样性，全面性及多功能性。2）设计思路前台：即用户端浏览器，浏览公司页面，浏览产品的图片、名称、及价格。 后台：即管理端浏览器，实现产品图片上传及相关文字介绍功能，编辑产品名称、编号、价格、图片等3）产品展示模块示意图用户端浏览器浏览产品浏览产品用途浏览产品制造浏览加工产品管理端浏览器相册管理产品管理产品编号产品名称产品图片8、公司相册模块1）功能描述展示公司举行的活动及相关图片，让游客更深入了解公司，直观的展示公司的人文气息和创造力，让游客感受到公司的生机与活力，这是一个充满激情的团队。2）设计思路前台：即用户端浏览器，浏览公司页面，浏览公司活动的照片，时间，地点，活动主题及参与人员。 后台：即管理端浏览器，实现活动照片上传及相关文字介绍功能，如删除、修改活动照片及文字介绍。3）公司相册模块示意图用户端浏览器浏览活动相册浏览活动举行的地点浏览活动时间浏览活动主题管理端浏览器相册管理上传照片删除照片修改信息活动时间9、首页模块1）功能描述整体展示公司的产品类型包括产品图片，种类等。展示产业结构及公司规模和公司的整体风貌。介绍山桐子发展起源等全方位的向游客作一个全面的介绍。2）设计思路前台：即用户端浏览器，浏览公司网站，浏览产品展示、新闻中心、关于我们、公司介绍、招聘信息、科技文献，在线留言等模块。后台：即管理端浏览器，通过相关技术手段编辑链接网站上的其他模块。如上传修改信息内容，上传删除图片，更新产业产品信息等，使游客可以自如的浏览公司首页。3）首页模块示意图用户端浏览器显示公司首页显示新闻相关内容管理端浏览器后台管理编排各模块上传信息内容发布招聘信息查看留言等四系统模块功能/功能模块的设计描述根据“需求分析说明书”及“网站演示版”完成功能功能描述及设计思路，详细描述与网站每一个子模块中的基本功能模块/对象相关联的需求。 功能描述描述此功能模块要达到的目标、所采用的方法和技术，可采用IPO图(输入处理输出图)的形式。 输入（1）详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定和有效输入范围等。（2）指明引用的接口说明或接口控制文件的参考资料。 处理（1）定义对输入数据、中间参数进行处理以获得预期输出结果的全部操作。包括：（2）输入数据的有效性检查(名称、标识、数据类型及格式、有效范围、输入形式)。（3）操作的顺序，包括事件的时间设定。（4）异常情况的响应，例如，溢出、通信故障、错误处理、影响的参数等。（5）用于把输入转换成相应输出的方法。 输出（1）输出数据的有效性检查(名称、标识、数据类型及格式、有效范围、输出形式)。（2）详细说明该功能的所有输出数据，例如，输出目的地、数量、度量单位、时间关系、有效输（1）出范围、非法值的处理、出错信息等。（3）有关接口说明或接口控制文件的参考资料(录属的上一层模块及下一层模块或程序，说明参数赋值及调用式)。1会员登录模块功能模块名会员用户登录所属部门账户管理部门开发人员赵霞功能描述(目的)输入用户名及密码，经过验证并通过，会员登录后，做为会员便可行驶会员专属的权利使 用 者普通游客、会员、管理员/超级管理员需求程序A技术前置条件(限制条件)会员用户必须先注册成功后成为会员用户后才能成功界面要求字体的大小与颜色统一，字间距与行距固定输入数据用户名和密码输入项检查根据输入用户名和密码通过后台程序dl及其数据库进行验证，查找是否是会员用户及正确的密码操作序列(算法或者处理描述逻辑流程)1.通过登录界面输入用户名及密码，点击“登录”按钮；2.调用后台程序dl，运用dl方法在数据库中进行查找验证用户名和密码；3.若找到用户名并且密码也正确则成功登录，否则弹出提示框“用户名或密码不正确，请重新输入！”，并回到登录界面；4.成功登录后提示“登录成功”，进入到首页界面，用户可以进行关于我们，产品展示，产品介绍，公司相册，新闻中心，招聘信息，科技文献，在线留言的浏览。异常/出错情况及处理1.用户名或密码不正确，请重新输入！则回到登录界面，并提示用户重新登录2.当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出”后置条件无预期结果用户名和密码不正确，则不能登录，若正确则成功登录。输出项检查是否出现提示信息“用户名或密码不正确，请重新输入”,若成功则出现“登录成功”。相关对象及 接 口首页：用于输入用户名和密码补充说明(注释设计)密码长度需要6个字符以上。测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 2关于我们模块功能模块名关于我们所属部门公司编辑部门开发人员张林鹏功能描述(目的)向浏览者详细介绍的我们公司的一切相关信息使 用 者普通游客、会员、管理员/超级管理员需求程序Aboutus前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)1.点击“关于我们”，进入关于“关于我们”页面；2.浏览“关于我们”的内容；3.点击“客服留言“跳转到在线留言；异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及 接 口首页：关于我们补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责3产品展示模块 功能模块名产业介绍所属部门公司开发部门开发人员杨露功能描述(目的)向浏览者详细的介绍了我公司的产品的信息，让来客更了解该产品的用途使 用 者普通游客、会员、管理员/超级管理员需求程序无前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)1.点击“产品展示”，浏览三种类型信息：创意概念、实体产品、其他2.点击“XXX”展示，通过程序中find()方法，基于产品展示类型基础上依据时间先后顺序显示展示图片及文字（最近时间显示在最前面）；3.点击“图片”在新的页面显示“标题”“实体产品图片”“购买订单”等；4.点击“客服留言“跳转到在线留言异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及 接 口首页：产业介绍补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 4产业介绍模块功能模块名产业介绍所属部门公司开发部门开发人员杨露功能描述(目的)向浏览者详细的介绍了我公司的产品的信息，让来客更了解该产品的用途使 用 者普通游客、会员、管理员/超级管理员需求程序无前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)1.点击“产业介绍”，进入关于“产业介绍”页面；2.浏览“产业介绍”的图片、文字信息；3.点击“客服留言“跳转到在线留言异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及 接 口首页：产业介绍补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 5公司相册模块功能模块名公司相册所属部门公司开发部门开发人员杨露功能描述(目的)向浏览者展示了我公司的公司活动的照片以及我公司实地产品相关的照片使 用 者普通游客、会员、管理员/超级管理员需求程序gsshow前置条件(限制条件)只有管理员成功登陆才可实现相册的上传界面要求字体的大小与颜色统一，字间距与行距固定输入数据需上传的相册的数据，以及对上传相册内容的描述输入项检查需上传的相册是否存在操作序列(算法或者处理描述逻辑流程)1.进入公司相册，浏览两种类型信息：山桐子相关产品、公司产品；2.点击“山桐子相关产品”，通过程序中find()方法，基于招聘类型基础上依据时间先后顺序显示公司相册内容及时间（最近时间显示在最前面）；3.点击“相册内容”在新的页面显示“标题”“图片”等信息；4.点击“客服留言“跳转到在线留言异常/出错情况及处理相册信息有误或不存在，显示提示框“该相册不存在，请重新选择！”并返回上传界面后置条件无预期结果相册信息存在错误，则不能上传；若正确则成功上传输出项检查是否出现提示信息“该相册不存在，请重新输入！”，若成功则出现“上传成功”相关对象及 接 口首页：公司相册补充说明(注释设计)无测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 6新闻中心模块功能模块名新闻中心所属部门公司编辑部门开发人员张林鹏功能描述(目的)向浏览者展示了我公司的公司新闻、公告以及行业新闻使 用 者普通游客、会员、管理员/超级管理员需求程序News前置条件(限制条件)作为管理员登陆成功后可进行新闻的上传界面要求字体的大小与颜色统一，字间距与行距固定输入数据需上传的新闻的标题，以及对所上传新闻内容的详细描述与验证码输入项检查需上传的新闻信息是否存在操作序列(算法或者处理描述逻辑流程)1.进入新闻中心，浏览三种类型新闻：公司新闻、公司公告、行业新闻；2.点击“公司新闻”新闻，通过程序中find（）方法，基于新闻类型基础上依据时间先后顺序显示新闻标题及时间（最近时间显示最前面）；3.点击“新闻标题”在新的页面显示“标题”“发布者”“发布时间”“发布内容”等；4.点击“客服留言“跳转到在线留言异常/出错情况及处理无后置条件无预期结果新闻中心的成功浏览输出项检查无相关对象及 接 口首页：新闻中心补充说明(注释设计)无测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责7招聘信息模块 功能模块名招聘信息所属部门人才管理部门开发人员胡芸儿功能描述(目的)向浏览者展示了我公司的招聘相关信息，包括全职岗位、兼职岗位以及实习岗位的信息使 用 者普通游客、会员、管理员/超级管理员需求程序A 、SQL 2005前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)1.进入招聘信息，浏览三种类型招聘：全职岗位、兼职岗位、实习岗位；2.点击“XXX”招聘，通过程序中find()方法，基于招聘类型基础上依据时间先后顺序显示招聘岗位及时间（最近时间显示在最前面）；3.点击“招聘岗位”在新的页面显示“标题”“职位职责”“任职资格”“应聘”等；4.点击“应聘”在新的页面显示“申请职位”“填写个人信息”“提交申请”等；5.点击“客服留言“跳转到在线留言异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及 接 口首页：招聘信息（zpxx）补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 8.科技文献模块 功能模块名科技文献所属部门公司技术部门开发人员陈齐瑜功能描述(目的)向浏览者展示了我公司的项目资料以及产品相关的杰出的论文，在用户登录后还可对山桐子相关论文进行下载浏览使 用 者普通游客、会员、管理员/超级管理员需求程序kjwx前置条件(限制条件)作为管理员登陆成功可编辑上传文章界面要求字体的大小与颜色统一，字间距与行距固定输入数据需上传的科技文献的标题，以及文献内容及上传时间输入项检查需上传的文献资料是否存在操作序列(算法或者处理描述逻辑流程)1.进入科技文献，浏览三个类型信息：山桐子论文下载、项目资料文集、其他；2.点击某篇科技文章，通过程序中find()方法，基于科技文献基础上依据时间先后顺序显示文献资料（最近时间显示在最前面）；3.点击科技文献标题，在新的页面显示文章标题，内容、上传时间等信息。4.点击“客服留言“跳转到在线留言异常/出错情况及处理无后置条件无预期结果科技文献页面成功显示输出项检查无相关对象及 接 口首页：科技文献补充说明(注释设计)无测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责 9在线留言模块功能模块名在线留言所属部门公司咨询部门开发人员冯明华功能描述(目的)输入想要表述的内容，留下留言者的联系方式，然后输入正确的验证码，就可以完成留言使 用 者普通游客、会员、管理员/超级管理员需求程序A、SQL 2005前置条件(限制条件)任何人都能够在进入本模块后留言界面要求字体的大小与颜色统一，字间距与行距固定输入数据留言问题、留言内容、联系人、验证码（必填）联系方式、xx、sfz（任填）输入项检查根据是否输入问题与内容，输入验证码是否正确，通过后台程序LY进行验证，确认能否成功留言操作序列(算法或者处理描述逻辑流程)1.进入在线留言，显示留言信息要求，填写“留言信息”；2.“点击提交”在新的页面显示自己所留言内容；异常/出错情况及处理1.“*不能为空”，则回到留言界面，表示用户可以重新留言2.“验证码不正确”，返回到留言界面，用户需重新留言后置条件无预期结果有内容未填为空和验证码不正确，则不能登录，反之则成功登录。输出项检查是否出现提示信息“*不能为空”或“验证码不正确”,若成功则出现“留言成功，审核等待中！”相关对象及 接 口首页：在线留言补充说明(注释设计)问题不得大于25个字符；内容不能少于10个字符测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责10公司首页模块功能模块名公司首页所属部门公司编辑部门开发人员赵霞功能描述(目的)总览网站信息，会员注册登录使 用 者普通游客、会员、管理员/超级管理员需求程序gssy前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)1.进入公司首页，可浏览六种类型信息：会员注册登录、产品展示、新闻中心、公司简介、成品展示、公司理念等相关信息2.点击“会员注册登录”，通过以及SQL 2005等技术实现会员的登录跳转以及信息注册，在将信息提交、审核通过可显示自己注册信息；3.点击“产品展示”，通过等技术实现产品展示页面的跳转；4.点击“产品展示”在新的页面显示“标题”“产品展示内容”等5.点击“新闻中心”，通过程序中find()方法，基于新闻类型基础上依据时间先后顺序显示招聘岗位新闻信息及时间（最近时间显示在最前面）；异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及 接 口首页：公司首页补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责六运行环境及补救措施1说明本系统的运行环境：支持Windows XP、Windows 2000等2说明故障出现后可能采取的变通措施（1）恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行（2）降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；（3）后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；七说明：张林鹏子模块系统模块功能/功能模块的设计描述、结构图的修改、引言、背景、定义的书写杨露子模块系统模块功能/功能模块的设计描述、网站前、后台各子模块功能间的功能描述及示意图冯明华子模块系统模块功能/功能模块的设计描述、程序结构图赵霞子模块系统模块功能/功能模块的设计描述、网站前、后台各子模块功能间的功能描述及示意图总体修改、文档格式修改陈其瑜子模块系统模块功能/功能模块的设计描述、参考资料的收集胡芸儿子模块系统模块功能/功能模块的设计描述、运行环境以及补救措施