企业即时通讯软件需求说明书.docx

1、企业即时通讯软件需求说明书技 术 文 件 技术文件名称： 企业即时通讯软件需求说明书 技术文件编号：IM-001-01 版 本：V1.0 拟 制 审 核 会 签 标准化 批 准 修改记录文件编号版本号拟制人/修改人拟制/修改日期更改理由主要更改内容（写要点即可）IM-001-01V1.02009-7-13新建注：文件第一次拟制时，“更改理由”、“主要更改内容”栏写“无”。1引言1.1编写目的本文通过详细描述企业即时通讯软件的功能需求、性能需求、质量属性需求、外部接口需求以及其它需求，为后续概要设计、软件（系统）测试、用户文档等工作提供基础与约束。1.2预期的读者和阅读建议预期的读者和阅读建议参

2、见表1.1。表1.1读者分类阅读重点备注项目经理全文，并据此编制/修订项目（软件）开发计划等。设计与开发工程师需求的完整性、正确性、可行性、优先级、无二义性，为概要设计作准备。售前、售后工程师/用户代表需求的必要性、优先级，并据此准备市场资料。测试工程师需求的可验证性，并据此准备（软件）系统测试方案。文档工程师全文，为编写用户文档作准备。1.3文档约定本文使用了如下的文档约定：1) 表头文字使用了20%灰度背景；2) 插图一律使用MS Visio 2002中文版绘制，并一律“嵌入”于需求描述正文中，而非“浮于文字上方”。；3) 用同号、同体但加粗的文字来强调需要读者重视的内容。另外，每个需求都

3、有优先级属性。优先级的可能取值为：5、4、3、2、1，具体定义如下：5：是必须的，它规定了产品的必备需求。没有这些需求，产品将不能完成用户的工作，从而也就无法达到市场的准入条件。4：是重要的，它规定了那些竞争对手已经实现且用户感觉很好的需求、本产品区别于其它同类产品的独特需求及其它一些需求。只有完成这些需求，才能使本产品有市场竞争力。3：是应该的，它规定了当前版本可以不做，但必须在未来版本中实现的需求。此种需求对产品的体系结构影响可能较大，因此必须在系统设计时予以考虑。2：是可能的，它规定了那些有了会更好但没有也没有什么关系的需求，如一些提高效率的小工具。1：是备忘的，它规定了我们想象的但目前

4、无法或无需实现的需求。2术语、定义和缩略语2.1术语、定义本文使用的专用术语、定义见表2.1： 表2.1术语/定义英文对应词含 义需求requirement指“被描述系统（SuD ，System Under Description）“做什么”（功能需求）及“做什么”时的水平（非功能需求，如性能需求、质量属性需求、外部接口需求、其它需求）。这个通俗定义是针对技术需求的，而非技术需求（如进度的限制）一般不在本文档中给出（一般放在研制任务书/项目计划中）。2.2缩略语本文使用的专用缩略语见表2.2：表2.2缩略语英文原文中文含义RRRaw Requirement原始需求URUser Requirem

5、ent用户需求IMInstant Messaging即时通讯JDKJava Development KitJava开发工具包JREJava Runtime EnvironmentJava 运行环境JVMJava Virtual MachineJava 虚拟机UCUser Case用例DBSDatabase Server数据库服务OUOrdinary Users普通用户3综合描述3.1背景IM 即时通讯系统，是以JAVA为基础实现的聊天系统，主要包括：登陆，注册，聊天，修改个人信息，添加好友，分组等功能模块。3.2软件概述本软件具备以下主要功能：a)点对点的聊天b)登陆，注册用户c)修改个人信息

6、d)添加好友e)分组3.3运行环境运行环境见表3.2。表3.2名 称硬件(CPU/RAM/HD)操作系统及其版本其它软件环境最低配置PIV3.0/1G/80Gwindows 2000 serverJre 1.5标准配置PIV双核2.0/1.5G/80Gwindows 2003 serverJre 1.53.4用户类及其要求本产品涉及到的用户类见表3.3。表3.3序号名 称说 明1应用系统用户其他应用系统的接入用户4具体需求4.1功能需求4.1.1SR-F-0010 登陆IM即时通讯系统本功能模块主要是为了让OU登陆IM，进行即时通讯登陆用例图如下：4.1.1.1SR-F-0010-01 启动即

7、时通讯客户端需求描述：启动即时通讯客户端，以便OU登陆IM执行者：OU优先级：5使用频度：高前置条件：C0010 系统管理员已启动即时通讯服务端及DBS。后置条件：正常过程：N1N0010 OU在系统中输入用户名及密码；N0020 提交数据后，系统输出”操作成功”，登陆到服务器；N0030 提交数据后，系统输出”用户名或密码有误”，返回登陆框。N0040 用例结束。N2N0010 OU在系统中输入用户名及密码；N0020 提交数据后，系统输出”用户名或密码有误”，返回登陆框。N0030 用例结束。可选过程：无异常过程：E1E0010 提交后,系统提示”操作失败”E2E0010 提交后，系统提示

8、“未连接上服务器”特殊需求：无验收准则：V1V0010 执行正常过程N1，N2，无异常； V0020 用例结束。4.1.2SR-F-0020 用户数据操作本功能模块主要是为了让OU注册IM和修改密码，进行即时通讯用户数据操作用例图如下：4.1.2.1SR-F-0020-01 用户注册需求描述：用户注册后，以便OU登陆IM执行者：OU优先级：5使用频度：中前置条件：C0010 已经启动即时通讯客户端。后置条件：正常过程：N1N0010 OU在系统界面中输入相应的用户信息；N0020 提交数据后，系统输出”操作成功”，用户注册成功；N0030 用例结束。N2N0010 OU在系统界面中输入相应的用

9、户信息；N0020 提交数据后，系统输出”用户名已存在”，返回焦点重新注册。N0030 用例结束。可选过程：无异常过程：E1E0010 提交后,系统提示”操作失败”特殊需求：无验收准则：V1V0010 执行正常过程N1，N2，无异常； V0020 用例结束。4.1.2.2SR-F-0020-02 用户修改密码需求描述：对已经注册的用户开放，让用户修改密码执行者：OU优先级：3使用频度：中前置条件：C0010 用户已经注册成功。后置条件：正常过程：N1N0010 OU在系统界面中输入用户的原始密码及新密码，两者相同后提交；N0020 提交数据后，系统输出”密码修改成功”，用户密码修改成功；N00

10、30 用例结束。可选过程：无异常过程：E1E0010 提交后,系统提示”操作失败”特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束。4.1.2.3SR-F-0020-03 用户找回密码需求描述：对已经注册的用户开放，让用户找回忘记的密码执行者：OU优先级：3使用频度：低前置条件：C0010 用户已经注册成功。后置条件：正常过程：N1N0010 OU在系统界面中根据用户的密码提示，输入相对应答案；N0020 提交数据后，系统输出该用户的密码；N0030 用例结束。N2N0010 OU在系统界面中根据用户的密码提示，输入相对应答案；N0020 提交数据后，系统

11、输出“答案不正确，请确认”；N0030 用例结束。可选过程：无异常过程：E1E0010 提交后,系统提示”操作失败”特殊需求：无验收准则：V1V0010 执行正常过程N1，N2，无异常； V0020 用例结束。4.1.3SR-F-0030 好友列表本功能模块主要是为了展示OU好友列表，进行即时通讯用户数据操作用例图如下：4.1.3.1SR-F-0030-01 展示好友列表需求描述：已经登陆的用户可以看到自己的好友列表执行者：OU优先级：5使用频度：高前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆后，可以看到系统输出的好友列表；N0020 用例结束。可选过

12、程：无异常过程：E1E0010 登陆后,好友列表加载失败特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束。4.1.3.2SR-F-0030-02 添加新好友需求描述：已经登陆的用户可以添加新好友到自己的好友列表中执行者：OU优先级：3使用频度：中前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆后，可以看到自己已经分好组的好友列表；N0020 OU 查询出准备添加的好友名字（别名）N0030 添加查询到的用户为好友并加载到相应的分组中N0040 系统提示“添加成功”N0050 用例结束。N2N0010 OU在登陆后，可以

13、看到自己已经分好组的好友列表；N0020 OU 查询出准备添加的好友名字（别名）N0030 添加查询到的用户为好友并加载到相应的分组中N0040 系统提示“添加失败”N0050 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 好友添加失败特殊需求：无验收准则：V1V0010 执行正常过程N1，N2，无异常； V0020 用例结束。4.1.3.3SR-F-0030-03 添加用户（好友）组需求描述：已经登陆的用户可以添加新的用户（好友）组执行者：OU优先级：4使用频度：中前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆

14、后，可以看到自己已经分好组的好友列表；N0020 OU 添加新的用户（好友）组，输入分组名称后提交N0030 系统提示“添加成功”N0040 用例结束。N2N0010 OU在登陆后，可以看到自己已经分好组的好友列表；N0020 OU 添加新的用户（好友）组，输入分组名称后提交N0030 系统提示“用户（好友）组已经存在，添加失败”N0040 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 用户组添加失败特殊需求：无验收准则：V1V0010 执行正常过程N1，N2，无异常； V0020 用例结束。4.1.3.4SR-F-0030-04 删除用户（好友）组需

15、求描述：已经登陆的用户可以删除用户（好友）组执行者：OU优先级：4使用频度：中前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆后，可以看到自己已经分好组的好友列表；N0020 OU 选中准备删除的用户（好友）组后提交N0030 系统提示“删除成功”N0040 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 用户组删除失败特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.3.5SR-F-0030-05 删除用户（好友）需求描述：已经登陆的用户可以删除用户（好友）执行者：OU优

16、先级：4使用频度：中前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆后，可以看到自己已经分好组的好友列表；N0020 OU 选中准备删除的用户（好友）后提交N0030 系统提示“删除成功”N0040 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 用户删除失败特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.3.6SR-F-0030-06 修改用户（好友）需求描述：已经登陆的用户可以修改用户（好友）好友备注执行者：OU优先级：4使用频度：中前置条件：C0010 用户已经登陆

17、成功。后置条件：正常过程：N1N0010 OU在登陆后，可以看到自己已经分好组的好友列表；N0020 OU 选中准备修改的用户（好友）后提交N0030 系统提示“修改成功”N0040 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 用户修改失败特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.3.7SR-F-0030-07 修改用户（好友）组需求描述：已经登陆的用户可以修改用户（好友）组组名执行者：OU优先级：4使用频度：中前置条件：C0010 用户已经登陆成功。后置条件：正常过程：N1N0010 OU在登陆后

18、，可以看到自己已经分好组的好友列表；N0020 OU 选中准备修改的用户（好友）组后提交N0030 系统提示“修改成功”N0040 用例结束。可选过程：无异常过程：E1E0010 登陆后,好友列表加载失败E2E0010 用户修改失败特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.4SR-F-0040 好友聊天本功能模块主要是为了OU与好友进行聊天，达到即时通讯用户数据操作用例图如下：4.1.4.1SR-F-0040-01 与好友进行通讯需求描述：已经登陆的用户可以与好友进行通讯执行者：OU优先级：5使用频度：高前置条件：C0010 好友列表已经加载

19、完成后置条件：正常过程：N1N0010 OU选中准备进行聊天的好友N0020 弹出聊天对话框N0030 进行聊天通讯。N0040 用例结束。可选过程：无异常过程：E1E0010 OU与好友不能连接不上（端口）E0020 线程一直处于阻塞中E0030 OU 与服务器无故断开特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.4.2SR-F-0040-02 发送图片需求描述：正在进行通讯OU可以给好友发送图片执行者：OU优先级：3使用频度：中前置条件：C0010 OU与好友处于通讯状态后置条件：正常过程：N1N0010 OU与好友正在进行聊天N0020 O

20、U选择图片以预览的形式发送给好友N0030 发送成功N0040 用例结束。可选过程：无异常过程：E1E0010 OU与好友不能连接不上（端口）E0020 线程一直处于阻塞中E0030 OU 与服务器无故断开特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.4.3SR-F-0040-03 保存聊天记录需求描述：正在进行通讯OU可以给保存聊天记录执行者：OU优先级：3使用频度：中前置条件：C0010 OU与好友处于通讯状态后置条件：正常过程：N1N0010 OU与好友正在进行聊天N0020 OU点击保存聊天记录后，可以把当前聊天窗口的记录写入指定的地址

21、N0030 提交后，系统显示“保存成功”N0040 用例结束。N2N0010 OU与好友正在进行聊天N0020 OU点击保存聊天记录后，可以把当前聊天窗口的记录写入指定的地址 N0030 提交后，系统显示“保存失败”N0040 用例结束。可选过程：无异常过程：E1E0010 OU与好友不能连接不上（端口）E0020 线程一直处于阻塞中E0030 OU 与服务器无故断开E0040 向系统写入文件错误特殊需求：无验收准则：V1V0010 执行正常过程N1,N2，无异常； V0020 用例结束4.1.4.4SR-F-0040-03 查看聊天记录需求描述：正在进行通讯OU可以给查看聊天记录执行者：OU

22、优先级：3使用频度：中前置条件：C0010 OU与好友处于通讯状态后置条件：正常过程：N1N0010 OU与好友正在进行聊天N0020 OU点击查看聊天记录后，弹出窗口显示聊天室记录N0030 用例结束。可选过程：无异常过程：E1E0010 OU与好友不能连接不上（端口）E0020 线程一直处于阻塞中E0030 OU 与服务器无故断开E0040 向系统读取文件错误特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.5SR-F-0050 个人信息设置本功能模块主要是为了OU修改个人信息 用户数据操作用例图如下：4.1.5.1SR-F-0050-01 修改

23、个人信息需求描述：修改登陆用户的个人信息执行者：OU优先级：3使用频度：中前置条件：C0010 用户已登陆后置条件：正常过程：N1N0010 点击查看个人信息，加载个人信息N0020 选中并修改需要修改的属性N0030 保存并提交N0040 用例结束。可选过程：无异常过程：E1E0010 加载个人信息失败E0020 提交后，系统显示“操作失败”特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.1.6SR-F-0060 系统信息的发送（待定）本功能模块主要是系统向用户发送信息用户数据操作用例图如下：4.1.6.1SR-F-0060-01 系统发送信息需求描

24、述：系统向已登陆的用户发送信息执行者：系统管理员优先级：3使用频度：中前置条件：C0010 系统管理员已登陆后置条件：正常过程：N1N0010 系统管理员在公告窗口中输入相关的信息N0020 发送给在线的其他客户N0030 用例结束。可选过程：无异常过程：E1E0010 提交后，系统显示“操作失败”特殊需求：无验收准则：V1V0010 执行正常过程N1，无异常； V0020 用例结束4.2性能需求无4.3质量属性需求4.3.1可靠性4.3.1.1STEM01-Q-0010 无缺陷性需求需求描述：1) 同行评审率：纳入配置管理的工作产品的同行评审率应达到100。2) 代码测试覆盖率：语句覆盖率应

25、达到100，条件覆盖率应达到95。3) 需求测试覆盖率：1004) 测试用例覆盖率：100优先级：54.3.1.2STEM01-Q-0020 健壮性需求需求描述：所有的参数都要指定一个缺省值，当输入数据丢失或无效时，自动使用缺省值。4.3.1.3IM-Q-0050 平均修复时间MTTR。需求描述：平均修复时间MTTR应小于2小时。4.3.1.4IM-Q-0060 异常记录需求需求描述：当发生异常时，软件应能记录操作系统版本、可用硬盘空间、最大物理内存及可用内存、用户的输入、错误类型；软件应能连续记录异常数据。4.3.1.5IM-Q-0070 数据一致性需求需求描述：软件必须在正常工作及发生异常

26、（如掉电、异常退出）的情况下都保持数据间的一致性。如果发生了不一致，应提供工具自动修复。4.3.1.6IM-Q-0080 反修改需求需求描述：软件应具有判断自身是否被修改（如被病毒感染）的能力。进一步地，如果自身已被修改，则应提醒用户如何进行恢复。4.3.2可维护性4.3.2.1IM-Q-0090 代码可读性需求需求描述：函数调用不能超过两层深度；每一个软件模块中，注释与源代码语句的比例至少为1 : 2 。4.3.3可移植性4.3.3.1IM-Q-0100 硬件独立性需求描述：软件应该无视（服务器）硬件环境，在任何（服务器）硬件环境可以正常运行。4.3.3.2IM-Q-0110 软件独立性需求

27、描述：软件应该无视操作系统，在任何支持JRE5.5以上系统的中可以正常运行。4.3.4扩展性需求描述：软件可以提供接口，让用户通过第三方接入的方法。4.3.5可测试性4.3.5.1IM-Q-0120 日志输出控制需求描述：在需要时，可以通过配置文件来控制内部关键信息的输出，输出目标也可通过配置文件配置。4.4外部接口需求暂无4.5其它需求暂无5总体验收准则a)总体验收计划由开发方编制，并经同行评审与批准。b)总体验收计划必须覆盖100%的优先级为5、4的需求，80%的优先级为3、2、1的需求。c)采用测试的方法进行验收，具体包括：d)1) 同行代表参加系统测试，并参加测试结果分析；e)2) 所有优先级为5、4的需求没有发现致命或主要的缺陷；f) 有小缺陷的优先级为3、2、1的需求不超过2%。g)3) 系统测试结果得到同行代表确认后，开发方提交并部署系统。h)4) 总体验收测试应在一个月内作出结论。6参考文献暂无