需求文档撰写参考(正式版)

项目名称 Project Name 密级 Confidentiality Level 酷我相册 仅供收件方查阅 项目编号 Project ID 版本 Version 文档编号 Document Code v9.5017.3187.15 V1.0 v9.5017.3187.15_Proc_RA_002       Cool Album Software Requirements specification 酷我相册系统需求规格说明 Prepared by 拟制 何杰逊、毛少枫 Date 日期   Reviewed by 评审人 李鹏 Date 日期   Approved by 批准 周伟 Date 日期           武汉市软酷网络科技有限公司 版权所有  不得复制 Copyright ? Ruankosoft Technologies(WuHan) Co., Ltd. All Rights Reserved Revision Record 修订记录 Date 日期 Revision Version 修订版本 CR ID /Defect ID CR/ Defect号 Sec No. 修改章节 Change Description 修改描述 Author 作者 2015.9.11 1.0   全部章节 初稿 何杰逊、毛少枫                                                                                                                         目录 1 Introduction 简介    6 1.1 Purpose 目的    6 1.2 Scope 范围    6 2 General description 总体概述    8 2.1 Software perspective 软件概述    8 2.1.1 About the Project 项目介绍    8 2.1.2 Environment of  Product 产品环境介绍    8 2.2 Software function 软件功能    8 2.3 User characteristics 用户特征    9 2.4 Assumptions & Dependencies 假设和依赖关系    9 3 Specific Requirements 具体需求    9 3.1 系统用例    9 3.2功能    9 3.2.1 登录功能    11 3.2.2 信息管理功能    11 3.2.3 相册管理    12 3.2.4 相片管理    12 3.3 数据字典    12 3.3.1 数据字典    12 3.3.2 E-R关系图    13 4 Performance Requirements 性能需求    14 4.1 时间性能需求    14 4.2 系统开放性需求    14 4.3 界面友好性需求    15 4.4 系统可用性需求    15 4.5 可管理性需求    15 5 Interface Requirements 接口需求    15 5.1 User Interface 用户接口    16 5.2 Software Interface 软件接口    16 5.3 Hardware Interface 硬件接口    16 5.4 Communication Interface 通讯接口    16 6 Overall Design Constraints 总体设计约束    16 6.1 Standards compliance 符合性    17 6.2 Hardware Limitations 硬件约束    17 6.3 Technology Limitations 技术限制    17 7 Software Quality Attributes 软件质量特性    17 7.1 Reliability 可靠性    18 7.2 Usability 易用性    18 8 Requirements Classification 需求分级    18 9 Appendix 附录    19 Keywords 关键词： Cool Album、酷我相册 Abstract  摘    要： List of abbreviations 缩略语清单： Abbreviations缩略语 Full spelling 英文全名 Chinese explanation 中文解释 DB datebase 数据库 FYI ForYourInformation 用户信息 GB Gigabit 千兆位                   1 Introduction 简介 1.1 Purpose 目的 该需求规格说明书是关于酷我相册用户对于酷我相册系统中投标管理的功能和性能的要求的描述，该说明书的预期读者为： 用户； 项目管理人员； 测试人员； 设计人员； 开发人员。 这份软件需求说明书重点描述了投标管理系统的功能需求，明确所要开发的软件应具有的功能、性能与界面，使系统分析人员及软件开发人员能清楚地了解用户的需求。 1.2 Scope 范围 本文档描述了系统的功能需求，数据字典，性能需求和接口需求等，不包含系统的具体设计内容。 1.2.1本指南用于指导软件开发者为南昌航空大学酷我相册开发软件的过程，为了达到提高软件质量，降低维护成本的目地。开发者应根据本指南进行软件和编制软件开发文档。本软件是对软件项目承担单位的基本要求。 1.2.2总体要求 网络应用环境以Internet/intranet技术为核心。 开发者应在充分分析需求的基础上，选择采用B/S或者C/S结构。 本指南给出了使用的技术要求，如下： 开发工具： Eclipse,MyEclipse,Junit,Rational Rose,ArgoUML,SVN 技术运用： Servlet&JSP,Struts,Spring,Hibernate,AJAX,JQuery 运行环境： Tomcat,JDK5.0 数 据 库： MySQL,SQL Server 1.2.3性能需求 为用户提供一个以存储、分享照片为核心，结合社区模式的平台，而且又兼具一些与众不同的功能的网络相册管理徐彤“酷我相册”，来满足用户的需求，就显得十分必要，也十分具有现实意义和价值了。 本系统立志为用户提供一个以存储、分享照片为核心，具有图片标识和绚丽效果处理功能、结合社区模式的分享平台。 2 General description 总体概述 2.1 Software perspective 软件概述 2.1.1 About the Project 项目介绍 本项目为一个新的独立项目：酷我相册（Cool Album）。 2.1.2 Environment of  Product 产品环境介绍 此处需要描述的是最终发布环境。 以java为例：需要win7系统，JDK1.7、Tomcat7.0、mysql、IE浏览器、Firefox浏览器、Chrome浏览器等，例如： 系统采用B/S结构，服务器端需要配置程序的运行环境（JDK1.6）、安装MySQL数据，用户端只需要通过浏览器就可以访问该网站。 2.2 Software function 软件功能 2.3 User characteristics 用户特征 1、用户：搜索查看图片，上传分享图片，添加好友。 2、管理员：审核图片。 2.4 Assumptions & Dependencies 假设和依赖关系 本系统使用Java语言进行开发的，采用MySQL进行数据的存储，系统采用B/S结构，用户只需要通过浏览器就可以访问网站。 3 Specific Requirements 具体需求 3.1 系统用例 3.2功能 1、功能简介 用户和管理员的信息管理。 2、子功能系统用例 3.2.12 查看好友功能 1 介绍 用户可以查看自己好友的主页上的相册相片 2 输入 点击好友列中好友的图标 3 处理 系统在后台查找好友的账号相册相片 4 输出 系统可弹出好友的相册相片 3.2.13 添加好友功能 1 介绍 用户向被添加的用户发送一条添加好友申请，被添加好友用户同意后及互为好友 2 输入 点击其他用户账户上的添加好友图标 3 处理 等待对方同意或拒绝 4 输出 诺对方同意则成为好友，拒绝则不成为好友 3.2.14 删除好友功能 1 介绍 用户删除自己好友的功能 2 输入 点击好友图标上的删除按钮 3 处理 系统将该好友从用户的好友列表中删除 4 输出 重新刷新好友列表 3.2.15 系统搜索功能 1 介绍 用户可以搜索系统中的用户以及用户用户公开的相册、相片 2 输入 点击输出需要搜索的用户的账户名 3 处理 后台搜索该用户的账户信息及其公开的相册，相片 4 输出 后台可弹出该用户的账户信息及其公开的相册，相片 3.2.16 发表和回复评论功能 1 介绍 用户可发布新的评论或对其他用户的评论进行回复 2 输入 输入发表评论或回复评论的内容 3 处理 系统将发表（或评论）的回复发表给好友（回复的好友） 4 输出 输出发表或回复的内容 3.2.17 删除评论功能 1 介绍 用户可删除自己发表的评论 2 输入 点击删除自己的评论按钮 3 处理 后台将该评论删除 4 输出 刷新该评论 3.2.18 查看评论功能 1 介绍 用户可查看自己发表的评论 2 输入 用户的个人中心点击查看 3 处理 后台查看用户的所哟评论 4 输出 输出该用户的所有评论 3.2.19 用户管理功能 1 介绍 对系统的用户信息进行管理 2 输入 点击对该用户的增加，删除或修改的按钮后输出新的用户信息 3 处理 后台对该用户的信息进行更新 4 输出 刷新该用户的信息并显示 3.2.20 相册相片管理功能 1 介绍 可查看并管理系统中用户公开的相册相片 2 输入 点击某用户的相册相片查看按钮 3 处理 后台查询该用户公开的相册相片 4 输出 输出该用户公开的相册相片 3.2.21 评论管理功能 1 介绍 可对系统中公开相片的评论进行管理 2 输入 点击评论上的增加，删除或修改按钮 3 处理 后台对该评论进行增加，删除或修改操作 4 输出 重新刷新该评论 3.2.22 数据统计功能 1 介绍 对系统的数据进行统计并形成图像报表 2 输入 打开数据页面，点击数据统计按钮 3 处理 后台将对系统数据进行统计并形成图像报表 4 输出 在原页面弹出统计的信息表和图像报表 3.3 数据字典 3.3.1 数据字典 用户 字段 类型 可为空 描述 User_Account Varchar(16) Not Null 账户 User_Sex varChar(1) Not Null 性别 User_Name varChar(20) Not Null 姓名 User_Password varChar(20) Not Null 密码         管理员 字段 类型 可为空 描述 Manager_Account String(16) Not Null 账户 Manager_Sex varChar(1) Not Null 性别 Manager_Name varChar(20) Not Null 姓名 Manager_Password varChar(20) Not Null 密码         相片 字段 类型 可为空 描述 Photo_Number String(50) Not Null 编号 Photo_Name varChar(20) Not Null 名字 Photo_Path Varchar(50) Not Null 路径 Photo_Type Varchar(20) Not Null 类型 Visible Boolean Not Null 可视         相册 字段 类型 可为空 描述 Album_Name varchar(20) Not Null 名字 Album_date datetime Not Null 日期 Album_Number Varchar(10) Not Null 图片 Visible Boolean Not Null 可视         用户好友 字段 类型 可为空 描述 User_Account Varchar(16) Not Null 名字 Friends_Account Varchar(16) Not Null 日期         相册相片 字段 类型 可为空 描述 Photo_Number Varchar(50) Not Null 相片 Album_Number Varchar(10) Not Null 相册         3.3.2 E-R关系图 、 / 4 Performance Requirements 性能需求 4.1 时间性能需求 系统处理能力：支持最大并发数50个用户。 响应速度：10秒内。 4.2 系统开放性需求 基于主流WINDOWS平台建设的酷我相册管理系统，使其具有良好的可扩充性和可移植性，系统可运行在主流的WINDOWS操作系统平台上，便于以后系统的升级。遵循主流的标准和协议，不仅可以为系统与上级平台系统交换信息提供便利，而且也有利于系统内部各部分之间交换信息，这将有助于提高系统扩充性。 4.3 界面友好性需求 系统提供统一的操作界面和方式。要求操作界面简洁美观，布局合理，功能完善，对于初级用户容易上手，并且提供适当的帮助信息。 4.4 系统可用性需求 系统操作快捷、内容完整是保证对用户进行使用的基础。因此，应准确而详细地理解各用户群特征、任务和使用环境，在“有效性”（完成特定任务和达到特定目标时所具有的正确性和完整程度）、“效率”（完成任务的正确性和完整程度与所使用资源，如时间之间的比率），以及“满意度”（在使用产品过程中具有的主观满意和接受程度）等方面满足各类用户对系统的要求 4.5 可管理性需求 系统涉及面较广，系统应提供对管理内容的分级分类管理和维护，对用户信息，管理员信息和相册及相片信息等 进行分类管理 5 Interface Requirements 接口需求 5.1 User Interface 用户接口 实现用户操作图形化界面，用户的交互界面都通过PC显示屏交互，分辨率基本已1024*768为主，600*800的较少，软件界面能自适应屏幕大小。 5.2 Software Interface 软件接口 无 5.3 Hardware Interface 硬件接口 主要为web服务器等环境交付。 5.4 Communication Interface 通讯接口 本系统使用HTTP等网络协议进行通讯 6 Overall Design Constraints 总体设计约束 6.1 Standards compliance 标准符合性 可以扩充以下所述规范中不存在的需求，但不能和规范相违背。反向竞拍网站应严格遵循《软酷 卓越实验室COE技术要求规范》、《软酷 卓越实验室COE编程规范要求》规范。 6.2 Hardware Limitations 硬件约束 可以扩充以下所述规范中不存在的需求，但不能和规范相违背。反向竞拍网站应严格遵循《软酷 卓越实验室COE技术要求规范》、《软酷 卓越实验室COE编程规范要求》规范。 6.3 Technology Limitations 技术限制 并行操作：保证数据的正确和完备性。 编程规范：Java编程规范。 7 Software Quality Attributes 软件质量特性 7.1 Reliability 可靠性 适应性：保证该系统在原有的基础功能上进行扩充，在原来的系统中增加新的业务功能，可方便的增加，而不影响原系统的架构。 容错性：在系统崩溃、内存不足的情况下，不造成该系统的功能失效，可正常关闭及重启。 可恢复性：出现故障等问，在恢复正常后，系统能正常运行。 7.2 Usability 易用性 易用性：具备良好的界面设计，使用户清晰易用，功能要高度集中。阻止用户输入非法数据或进行非法操作，对于复杂的流程处理，应该提供向导功能并注释。可随时给用户提供使用帮助。 8 Requirements Classification 需求分级 Requirement ID 需求ID Requirement Name 需求名称 Classification 需求分级   登陆,注册模块 B   用户信息管理模块 A   相册信息管理模块 A   相片信息管理模块 A   用户搜索模块 C                   重要性分类如下： A.    必须的        绝对基本的特性；如果不包含，产品就会被取消。 B.    重要的        不是基本的特性，但这些特性会影响产品的生存能力。 C.    最好有的        期望的特性；但省略一个或多个这样的特性不会影响产品的生存能力。 9 Appendix 附录 系统流程图