搜索
网站软件(结构)设计说明书一．引言1．引言说明编写这份说明书的目的，指出预期的读者。2．背景3．定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。4．参考资料列出有关的参考资料，如：(1)本项目的经核准的计划任务书或合同、上级机关的批文；(2)属于本项目的其他已发表的文件；如开发标准(3)本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。示例：[1]XXX．需求分析说明书．内部参考资料，2013.4[2]XXX．网站建设标准规范说明书．内部参考资料，2013.5[3]XXX．数据库设计说明书．内部参考资料，2013.5[4]顾正刚．网站规划与建设．机械工业出版社，2010.2二．模块/程序系统的组织结构根据“需求分析说明书”的功能表及流程图，设计系统功能模块间的组织结构。用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.示例：新闻发布系统的程序(模块)间的组织结构如图1所示:图1系统的组织结构1.公司首页系统的程序(模块)间的组织结构图生成静态页面管理端浏览器管理在线留言显示留言、回复、删除留言添加广告修改广告删除广告广告列表广告发布栏目管理栏目列表修改栏目删除栏目编辑登录编辑权限管理权限管理编辑管理模版编辑添加模版修改模版删除模版模版列表栏目管理栏目列表修改栏目删除栏目添加栏目新闻管理新闻列表添加新闻修改新闻删除新闻新闻发布新闻发布系统图1公司首页系统的组织结构2.关于我们系统的程序(模块)间的组织结构图图2关于我们系统的组织结构3.产品展示系统的程序(模块)间的组织结构图图3产品展示系统的组织结构4.产业介绍系统的程序(模块)间的组织结构图图4产品展示系统的组织结构5.科技文献系统的程序(模块)间的组织结构图图5科技文献系统的组织结构6.新闻中心系统的程序(模块)间的组织结构图图6新闻中心系统的组织结构7.公司相册系统的程序(模块)间的组织结构图图7公司相册系统的组织结构8.招聘信息系统程序(模块)间的组织结构图图8招聘信息系统的组织结构9.在线留言系统的程序(模块)间的组织结构图图9在线留言系统的组织结构三．网站前、后台各子模块功能间的功能描述及示意图基于网站整体结构组织图基础上，实现前、后台模块功能的功能描述、设计思路、示意图.1.新闻中心1）功能描述展示相关新闻，通过新闻让浏览者了解更多相关信息。2）设计思路前台：即用户端浏览器，实现查看新闻功能（查看新闻及其相关内容）后台：即管理端浏览器，实现新闻管理功能（上传新闻、编辑、删除新闻）3）新闻中心模块示意图2.招聘信息1）功能描述通过招聘信息让浏览者了解公司需要招聘哪些人才。2）设计思路前台：即用户端浏览器，实现查看招聘信息功能（查看招聘条件）后台：即管理端浏览器，实现招聘信息管理功能（统计报名人数，显示报名用户的基本资料）3）招聘信息模块示意图3.在线留言模块1）功能描述用户端浏览器查看新闻查看新闻相关内容管理端浏览器管理新闻上传新闻、编辑、删除新闻用户端浏览器查看招聘信息查看招聘条件管理端浏览器管理招聘信息统计报名人数显示报名用户的基本资料通过在线留言，快速有效地收集用户的意见及建议。2）设计思路前台：即用户端浏览器，实现在线留言功能（用户填写并提交留言、查看留言）后台：即管理端浏览器，实现在线留言管理功能（显示留言、回复、删除留言）3）在线留言模块示意图4．产品介绍1）功能描述通过产品介绍，让浏览者了解产品的相关信息。2）设计思路前台：即用户端浏览器，实现查看产品介绍功能（查看产品名称、来源、种类、功能用途等）后台：即管理端浏览器，实现产品介绍管理功能（编辑、显示产品介绍）3）产品介绍模块示意图4．关于我们1）功能描述通过介绍本公司，让浏览者了解本公司的发展。2）设计思路前台：即用户端浏览器，实现查看公司介绍功能（查看公司发展、规模、主要产品、加工技术等）后台：即管理端浏览器，实现公司介绍管理功能（编辑、显示公司介绍）用户端浏览器在线留言填写并提交留言、查看留言用户端浏览器查看产品介绍查看产品名称、来源、种类、功能用途等管理端浏览器管理产品介绍编辑产品介绍内容显示产品介绍内容3）关于我们模块示意图示例：网上调查模块1）功能描述及时获取市场对我公司要求或希望有，通过在线显示调查结果，快速有效地收集用户的意见及建议。2）设计思路前台：即用户端浏览器，实现网上调查功能，如调查选项、用户选择并提交调查结果、查看调查结果等功能。后台：即管理端浏览器，实现调查管理功能，如设置调查选项、设置调查表样式、统计调查结果、显示调查结果。3）调查模块示意图四．系统模块功能/功能模块的设计描述根据“需求分析说明书”及“网站演示版”完成功能功能描述及设计思路，详细描述与网站每一个子模块中的基本功能模块/对象相关联的需求。①功能描述描述此功能模块要达到的目标、所采用的方法和技术，可采用IPO图(输入－处理－输出图)的形式。②输入◆详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定和有效输入范围等。用户端浏览器实施调查显示调查表/选项填写并提交调查表查看调查结果管理端浏览器管理调查设置调查选项设置调查表样式统计调查结果显示调查结果用户端浏览器查看产品介绍查看公司发展、规模、主要产品、加工技术等管理端浏览器管理产品介绍编辑、显示公司介绍◆指明引用的接口说明或接口控制文件的参考资料。③处理定义对输入数据、中间参数进行处理以获得预期输出结果的全部操作。包括：◆输入数据的有效性检查(名称、标识、数据类型及格式、有效范围、输入形式)。◆操作的顺序，包括事件的时间设定。◆异常情况的响应，例如，溢出、通信故障、错误处理、影响的参数等。◆用于把输入转换成相应输出的方法。④输出◆输出数据的有效性检查(名称、标识、数据类型及格式、有效范围、输出形式)。◆详细说明该功能的所有输出数据，例如，输出目的地、数量、度量单位、时间关系、有效输出范围、非法值的处理、出错信息等。◆有关接口说明或接口控制文件的参考资料(录属的上一层模块及下一层模块或程序，说明参数赋值及调用式)。1．会员登录模块示例：会员登录模块功能模块名会员用户登录所属部门XXX开发人员功能描述(目的)输入正确的用户名及密码，经过验证并通过，会员用户就能成功登录，做为会员便可浏览相应页面使用者会员、管理员/超级管理员需求程序XX前置条件(限制条件)会员用户必须先注册成功后成为会员用户后才能成功界面要求120×90px输入数据用户名和密码输入项检查根据输入用户名和密码通过后台程序XX及其数据库进行验证，查找是否是会员用户及正确的密码操作序列(算法或者处理描述逻辑流程)a.通过登录界面输入用户名及密码，点击“登录”按钮；b.调用后台程序XX，运用XX方法在数据库中进行查找验证用户名和密码；c.若找到用户名并且密码也正确则成功登录，否则弹出提示框“用户名或密码不正确，请重新输入！”，并回到登录界面；d.成功登录后提示“恭喜您登录成功”，进入到XXX界面或XXX页面，用户可以进行...异常/出错情况及处理1．用户名或密码不正确，请重新输入！则回到登录界面，并提示用户重新登录2．当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出”后置条件无预期结果用户名和密码不正确，则不能登录，若正确则成功登录。输出项检查是否出现提示信息“用户名或密码不正确，请重新输入”,若成功则出现“恭喜您登录成功”。相关对象及接口首页：用于输入用户名和密码XXX程序：进行到XX页面补充说明(注释设计)说明本模块中所需要的提示信息测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责功能模块名会员用户登录所属部门账户管理部门开发人员赵霞功能描述(目的)输入用户名及密码，经过验证并通过，会员登录后，做为会员便可行驶会员专属的权利使用者普通游客、会员、管理员/超级管理员需求程序DL前置条件(限制条件)会员用户必须先注册成功后成为会员用户后才能成功界面要求输入数据用户名和密码输入项检查根据输入用户名和密码通过后台程序DL及其数据库进行验证，查找是否是会员用户及正确的密码操作序列(算法或者处理描述逻辑流程)a.通过登录界面输入用户名及密码，点击“登录”按钮；b.调用后台程序DL，运用DL方法在数据库中进行查找验证用户名和密码；c.若找到用户名并且密码也正确则成功登录，否则弹出提示框“用户名或密码不正确，请重新输入！”，并回到登录界面；d.成功登录后提示“登录成功”，进入到XXX界面或XXX页面，用户可以进行关于我们，产品展示，产品介绍，公司相册，新闻中心，招聘信息，科技文献，在线留言的浏览。异常/出错情况及处理1．用户名或密码不正确，请重新输入！则回到登录界面，并提示用户重新登录2．当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出”后置条件无预期结果用户名和密码不正确，则不能登录，若正确则成功登录。输出项检查是否出现提示信息“用户名或密码不正确，请重新输入”,若成功则出现“登录成功”。相关对象及接口首页：用于输入用户名和密码补充说明(注释设计)密码长度需要6个字符以上。测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责功能模块名关于我们所属部门XXX开发人员赵霞功能描述(目的)向浏览者详细介绍的我们公司的一切相关信息使用者普通游客、会员、管理员/超级管理员需求程序无前置条件(限制条件)无界面要求字体的大小与颜色统一，字间距与行距固定输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)a.通过首页界面导航栏中的“关于我们”跳转；b.直接进入界面进行浏览；异常/出错情况及处无理后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及接口首页：关于我们补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责功能模块名产品展示所属部门XXX开发人员功能描述(目的)向浏览者展示本网站的主要产品，直接预览产品图片使用者普通游客、会员、管理员/超级管理员需求程序无前置条件(限制条件)无界面要求图片的大小、间距、行距有固定值输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)a.通过首页界面导航栏中的“产品展示”跳转；b.直接进入界面进行浏览；异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及接口首页：产品展示补充说明(注释设计)本模块中的图片属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责功能模块名产品介绍所属部门开发人员赵霞功能描述(目的)向浏览者详细的介绍了我公司的产品的信息，让来客更了解该产品的用途使用者普通游客、会员、管理员/超级管理员需求程序无前置条件(限制条件)无界面要求图片的大小、间距、行距有固定值输入数据无输入项检查无操作序列(算法或者处理描述逻辑流程)a.通过首页界面导航栏中的“产品展示”跳转；b.直接进入界面进行浏览；异常/出错情况及处理无后置条件无预期结果成功进入网站后，可以浏览本网页，否则不能浏览输出项检查无相关对象及接口首页：产品介绍补充说明(注释设计)本模块中的信息属于公司资料，不可随意复制粘贴测试计划对模块进行测试的计划L：测试技术要求、输入数据、预期结果、进度安排、人员职责功能模块名公司相册所属部门开发人员赵霞功能描述(目的)向浏览者展示了我公司的公司活动的照片以及我公司实地产品相关的照片使用者普通游客、会员、管理员/超级管理员需求程序SC前置条件(限制条件)只有管理员成功登陆才可实现相册的上传界面要求120×90px输入数据需上传的相册的数据，以及对上传相册内容的描述输入项检查需上传的相册是否存在操作序列(算法或