附录A软件需求分析报告文档模板

附录A软件需求分析报告文档模板1综合描述-------------------------------------------------------------------------------21.1产品的功能-------------------------------------------------------------------------21.2用户类和特性----------------------------------------------------------------------21.3运行环境----------------------------------------------------------------------------21.4设计和实现上的限制-------------------------------------------------------------22外部接口需求-------------------------------------------------------------------------32.1用户界面----------------------------------------------------------------------------32.2硬件接口----------------------------------------------------------------------------32.3软件接口----------------------------------------------------------------------------62.4通讯接口----------------------------------------------------------------------------63系统功能需求-------------------------------------------------------------------------74其它非功能需求----------------------------------------------------------------------74.1性能需求----------------------------------------------------------------------------74.2安全措施需求----------------------------------------------------------------------84.3安全性需求-------------------------------------------------------------------------84.4软件质量属性----------------------------------------------------------------------94.5业务规则----------------------------------------------------------------------------95分析模型-------------------------------------------------------------------------------91.综合描述系统名称：QQ网络聊天系统（QQS）QQ聊天系统为用户网络聊天交流信息提供一个方便的电子平台。该系统分用户员注册信息部分和后台系统管理部分。用户通过向服务器提交信息，在数据库中写入相应的数据。用户可以根据好友的QQ号码或者是昵称来添加好友，而后选中该好友之后进行聊天功能。如果对方没有在线，则将内容保存在服务器上，等用户上线之后传送信息。用户可以对自己的信息进行维护和修改，服务器通过对用户的权限进行验证，修改对应的信息。该系统的主要用户群是：（1）聊天者；（2）服务端管理员。1.1产品的功能因为将在需求分析报告的第4部分中详细描述软件产品的功能，所以在此只需要概略地总结。仅从业务层面陈述本软件产品所应具有的主要功能，在描述功能时应该针对每一项需求准确地描述其各项规格说明。如果存在引起误解的可能，在陈述本软件产品主要功能的作用领域时，也需要对应陈述本软件产品的非作用领域，以利读者理解本软件产品。为了很好地组织产品功能，使每个读者都容易理解，可以采用列表的方法给出。也可以采用图形方式，将主要的需求分组以及它们之间的联系使用数据流程图的顶层图或类图进行表示，这种表示方法是很有用的。参考用户当前管理组织构架，了解各个机构的主要职能，将有助于陈述软件产品的主要功能。1.2用户类和特性确定有可能使用该软件产品的不同用户类，并且描述它们相关的特征。往往有一些软件需求，只与特定的用户类有关。描述时，应该将该软件产品的重要用户类与非重要用户类区分开。用户不一定是软件产品的直接使用者，通过报表、应用程序接口、系统硬件接口得到软件产品的数据和服务的人、或者机构也有他们的需求。所以，应该将这些外部需求视为通过报表、应用程序接口、系统硬件接口附加给软件产品的附加用户类。1.3运行环境服务器要求硬件部分：处理器主频要求1GHz以上；内存512M(或更高)；VGA视频显示器；标准的鼠标、键盘；兼容印机。软件部分：操作系统为Windows各版本操作系统；数据库系统为SQLServer2005企业版.客户端要求硬件部分：处理器P2,600MHZ(以上)；内存128M(或更高)；显示器。软件部分：操作系统为Window98,Window2000，WindowsXP或者WindowsVista系列，浏览器为IE5.0(或更高)，或者其它网页浏览器。1.4设计和实现上的限制确定影响开发人员自由选择的问题，并且说明这些问题为什么成为一种限制。可能的限制包括下列内容：●必须使用的特定技术、工具、编程语言和数据库；●避免使用的特定技术、工具、编程语言和数据库；●要求遵循的开发规范和标准2.外部接口需求与数据库的接口：系统单独安装在服务器上，数据库与系统放在同一个服务器上，数据库资料要经常由DBA做备份。2.1用户界面说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。（出错处理部分见该文档的出错处理部分）注册模块。用户首先应该进入登录界面，其中就是QQ号码和密码，若未注册过，则应该先进行注册申请号码：用户注册信息接口设计信息内容输入方法字段类型会员登陆名用户输入Textfield用户年龄用户输入Textfield性别用户选择Radiobutton密码用户输入Password确认密码用户输入Password登录按钮用户点击Button取消按钮用户点击Button注册成功则跳转到用户登录界面，输入用户名和密码之后进行登录。失败后则跳出错误信息，然后显示重新注册界面。登录界面，主要负责会员的登录，输入的信息有：登录界面输入接口设计信息内容输入方法字段类型用户名用户输入Textfield用户密码会员输入Password登录按钮会员点击Button取消按钮会员点击Button注册连接会员点击link当登录成功后，登录界面的信息变成欢迎信息。登录的主界面的接口设计添加好友模块。用户可以选择自己需要添加的好友ID号码或者用户名，显示搜索结构，并且选择是否添加好友：添加好友的接口设计信息内容输入方法字段类型好友ID用户输入Textfield好友昵称用户输入Textfield搜索按钮用户点击Button退出等会员点击Button搜索结构若没有改好友，显示错误信息，并返回搜索页面。若查找到指定信息，则显示该好友，用户判断是否加为好友。用户个人信息修改接口。修改个人信息的接口设计信息内容输入方法字段类型用户昵称用户输入Textfield用户密码用户输入Textfield用户性别用户选择Textfield用户年龄用户输入Select用户头像：用户名用户的好友列表：用户的其他操作最小化和退出等搜索结果显示页面，用户点击添加好友之后，会出现选择好友的信息。用户填完了相应的内容之后，点击搜索按键。通过搜索服务器端数据库中的内容，查找该好友是否存在。存在，出现搜索结果界面。用户可以选择是否添加该用户为好友，选择之后，判断该用户是否在线，服务器选择向用户发送消息。搜索好友的接口设计聊天时该系统的主要功能。用户可以通过右键点击自己的好友，选择查看向改好友发送信息。并且接受用户发来的信息等，同时可以回复好友信息。聊天框接口设计用户名年龄用户密码输入用户性别选择修改确认输入密码好友昵称用户的ID号选择搜索按钮搜索结果信息总汇，包括该用户的相应信息，共搜索到多少条的记录等信息添加好友按钮，可以点击添加取消按钮，放弃当前的选择后台管理显示当前系统状态。当前用户信息状态的接口设计信息内容输入方法字段类型用户姓名显示（不能修改）列表项用户ID显示（不能修改）列表项用户年龄显示（不能修改）列表项用户性别显示（不能修改）列表项用户在线状态显示（不能修改）列表项2.2硬件接口描述待开发的软件产品与系统硬件接口的特征，若有多个硬件接口，则必须全都描述。2.3软件接口本软件应用WindowsApi实现对数据库的操作，基于ODBC数据库访问技术。本产品的用户一般需要通过终端进行操作，进入主界面后点击相应的窗口，分别进入相对应的界面(如：输入界面、查询界面)。用户对程序的维护，最好要有备份。数据通信协议：Tcp/Ip,UDP协议等通讯接口描述与软件产品所使用的通讯功能相关的需求。信息显示部分。包括好友发来地信息以及自己发送给好友的信息。其中包括时间信息。发送按钮。点击按钮之后发送信息给好友退出按钮。退出当前与好友聊天。用户需要给好友发送的信息。这里的信息输入后点击发送，会发送给对方好友，同时会在自己的对话框中显示信息最小化最大化关闭3.系统功能需求需要进行详细的需求记录，详细列出与该系统功能相关的详细功能需求，并且，唯一地标识每一项需求。这是必须提交给用户的软件功能，使得用户可以使用所提供的功能执行服务或者使用所指定的使用实例执行任务。描述软件产品如何响应己知的出错条件、非法输入、非法动作。如果每一项功能需求都能用一项，也只需要用一项测试用例就能进行验证，那么就可以认为功能需求已经适当地进行描述了。如果某项功能需求找不到合适的测试用例，或者必须使用多项测试用例才能验证，那么该项功能需求的描述必然存在某些问题。功能需求是根据系统功能，即软件产品所提供的主要服务来组织的。可以通过使用实例、运行模式、用户类、对象类或者功能等级来组织这部分内容，也可以便用这些元素的组合。总而言之，必须选择一种是读者容易理解预期产品的组织方案。用简短的语句说明功能的名称，例如：“4.1系统参数管理”。按照服务组织的顺序，逐条阐述系统功能。无论说明的是何种功能，都应该针对该系统功能重复叙述4.1~4.3这三个部分。可以通过各种方式来组织这一部分内容，例如采用：使用实例、运行模式、用户类、对象类、功能等级等，也可以采用它们的组合。其最终目的是，让读者容易理解即将开发的软件产品。一般来说，每个使用实例都对应一个系统功能，因而按照使用实例来组织内容比较容易让用户理解。对应一些被共享的独立使用实例，可以定义一些公用系统功能。必须特别注意的是，在2.2节“产品的功能”中描述的全部需求，以及它们的规格说明；必须在某个系统功能描述中有所反映，而且不应重复。4.其它非功能需求在这里列举出所有非功能需求，主要包括可靠性、安全性、可维护性、可扩展性、可测试性等。4.1性能需求阐述不同应用领域对软件产品性能的需求，并且说明提出需求的原理或者依据，以帮助开发人员做出合理的设计选择。尽可能详细地描述性能需求，如果需要，可以针对每个功能需求或者特征分别陈述其性能需求。4.2安全措施需求出错信