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

技 术 文 件 技术文件名称 企业即时通讯软件需求说明书 技术文件编号 IM 001 01 版 本 V1 0 拟 制 审 核 会 签 标准化 批 准 修改记录修改记录 文件编号版本号 拟制人 修改人 拟制 修 改日期 更改理由 主要更改内容 写要点即可 IM 001 01V1 02009 7 13新建 注 文件第一次拟制时 更改理由 主要更改内容 栏写 无 目目 录录 1引言引言 4 1 1编写目的 4 1 2预期的读者和阅读建议 4 1 3文档约定 4 2术语 定义和缩略语术语 定义和缩略语 4 2 1术语 定义 4 2 2缩略语 5 3综合描述综合描述 5 3 1背景 5 3 2软件概述 5 3 3运行环境 5 3 4用户类及其要求 6 4具体需求具体需求 7 4 1功能需求 7 4 1 1SR F 0010 登陆IM即时通讯系统 7 4 1 2SR F 0020 用户数据操作 8 4 1 3SR F 0030 好友列表 10 4 1 4SR F 0040 好友聊天 16 4 1 5SR F 0050 个人信息设置 20 4 1 6SR F 0060 系统信息的发送 待定 21 4 2性能需求 22 4 3质量属性需求 22 4 3 1可靠性 22 4 3 2可维护性 23 4 3 3可移植性 23 4 3 4扩展性 23 4 3 5可测试性 23 4 4外部接口需求 23 4 5其它需求 23 5总体验收准则总体验收准则 23 6参考文献参考文献 24 1引言引言 1 1编写目的编写目的 本文通过详细描述企业即时通讯软件的功能需求 性能需求 质量属性需求 外部接 口需求以及其它需求 为后续概要设计 软件 系统 测试 用户文档等工作提供基础与 约束 1 2预期的读者和阅读建议预期的读者和阅读建议 预期的读者和阅读建议参见表 1 1 表 1 1 读者分类阅读重点备注 项目经理全文 并据此编制 修订项目 软件 开发计划等 设计与开发 工程师 需求的完整性 正确性 可行性 优先级 无二义性 为概要设 计作准备 售前 售后 工程师 用户 代表 需求的必要性 优先级 并据此准备市场资料 测试工程师需求的可验证性 并据此准备 软件 系统测试方案 文档工程师全文 为编写用户文档作准备 1 3文档约定文档约定 本文使用了如下的文档约定 1 表头文字使用了 20 灰度背景 2 插图一律使用 MS Visio 2002 中文版绘制 并一律 嵌入 于需求描述正文中 而非 浮于文字上方 3 用同号 同体但加粗的文字来强调需要读者重视的内容 另外 每个需求都有优先级属性 优先级的可能取值为 5 4 3 2 1 具体定义 如下 5 是必须的 它规定了产品的必备需求 没有这些需求 产品将不能完成用户的工作 从而也就无法达到市场的准入条件 4 是重要的 它规定了那些竞争对手已经实现且用户感觉很好的需求 本产品区别于 其它同类产品的独特需求及其它一些需求 只有完成这些需求 才能使本产品有市场竞争 力 3 是应该的 它规定了当前版本可以不做 但必须在未来版本中实现的需求 此种需 求对产品的体系结构影响可能较大 因此必须在系统设计时予以考虑 2 是可能的 它规定了那些有了会更好但没有也没有什么关系的需求 如一些提高效 率的小工具 1 是备忘的 它规定了我们想象的但目前无法或无需实现的需求 2术语 定义和缩略语术语 定义和缩略语 2 1术语 定义术语 定义 本文使用的专用术语 定义见表 2 1 表 2 1 术语 定义英文对应词含 义 需求requirement 指 被描述系统 SuD System Under Description 做什么 功能需求 及 做什么 时的水平 非功能需求 如性能需求 质量属性需求 外部接口需求 其它需求 这个通俗定义是针对 技术需求的 而非技术需求 如进度的限制 一般不在本文档中 给出 一般放在研制任务书 项目计划中 2 2缩略语缩略语 本文使用的专用缩略语见表 2 2 表 2 2 缩略语英文原文中文含义 RRRaw Requirement原始需求 URUser Requirement用户需求 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 修改个人信息 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 5 3 4用户类及其要求用户类及其要求 本产品涉及到的用户类见表 3 3 表 3 3 序号名 称说 明 1应用系统用户其他应用系统的接入用户 4具体需求具体需求 4 1功能功能需求需求 4 1 1SR F 0010 登陆登陆 IM 即时通讯系统即时通讯系统 本功能模块主要是为了让 OU 登陆 IM 进行即时通讯 登陆用例图如下 4 1 1 1SR F 0010 01 启动即时通讯客户端启动即时通讯客户端 需求描述需求描述 启动即时通讯客户端 以便 OU 登陆 IM 执行者执行者 OU 优先级优先级 5 使用频度使用频度 高 前置条件前置条件 C0010 系统管理员已启动即时通讯服务端及 DBS 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在系统中输入用户名及密码 N0020 提交数据后 系统输出 操作成功 登陆到服务器 N0030 提交数据后 系统输出 用户名或密码有误 返回登陆框 N0040 用例结束 N2 N0010 OU 在系统中输入用户名及密码 N0020 提交数据后 系统输出 用户名或密码有误 返回登陆框 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010提交后 系统提示 操作失败 E2 E0010 提交后 系统提示 未连接上服务器 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 2SR F 0020 用户数据操作用户数据操作 本功能模块主要是为了让 OU 注册 IM 和修改密码 进行即时通讯 用户数据操作用例图如下 4 1 2 1SR F 0020 01 用户注册用户注册 需求描述需求描述 用户注册后 以便 OU 登陆 IM 执行者执行者 OU 优先级优先级 5 使用频度使用频度 中 前置条件前置条件 C0010 已经启动即时通讯客户端 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在系统界面中输入相应的用户信息 N0020 提交数据后 系统输出 操作成功 用户注册成功 N0030 用例结束 N2 N0010 OU 在系统界面中输入相应的用户信息 N0020 提交数据后 系统输出 用户名已存在 返回焦点重新注册 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010提交后 系统提示 操作失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 2 2SR F 0020 02 用户修改密码用户修改密码 需求描述需求描述 对已经注册的用户开放 让用户修改密码 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 用户已经注册成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在系统界面中输入用户的原始密码及新密码 两者相同后提交 N0020 提交数据后 系统输出 密码修改成功 用户密码修改成功 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010提交后 系统提示 操作失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 2 3SR F 0020 03 用户找回密码用户找回密码 需求描述需求描述 对已经注册的用户开放 让用户找回忘记的密码 执行者执行者 OU 优先级优先级 3 使用频度使用频度 低 前置条件前置条件 C0010 用户已经注册成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在系统界面中根据用户的密码提示 输入相对应答案 N0020 提交数据后 系统输出该用户的密码 N0030 用例结束 N2 N0010 OU 在系统界面中根据用户的密码提示 输入相对应答案 N0020 提交数据后 系统输出 答案不正确 请确认 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010提交后 系统提示 操作失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 3SR F 0030 好友列表好友列表 本功能模块主要是为了展示 OU 好友列表 进行即时通讯 用户数据操作用例图如下 4 1 3 1SR F 0030 01 展示好友列表展示好友列表 需求描述需求描述 已经登陆的用户可以看到自己的好友列表 执行者执行者 OU 优先级优先级 5 使用频度使用频度 高 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到系统输出的好友列表 N0020 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 3 2SR F 0030 02 添加新好友添加新好友 需求描述需求描述 已经登陆的用户可以添加新好友到自己的好友列表中 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 查询出准备添加的好友名字 别名 N0030 添加查询到的用户为好友并加载到相应的分组中 N0040 系统提示 添加成功 N0050 用例结束 N2 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 查询出准备添加的好友名字 别名 N0030 添加查询到的用户为好友并加载到相应的分组中 N0040 系统提示 添加失败 N0050 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010好友添加失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 3 3SR F 0030 03 添加用户 好友 组添加用户 好友 组 需求描述需求描述 已经登陆的用户可以添加新的用户 好友 组 执行者执行者 OU 优先级优先级 4 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 添加新的用户 好友 组 输入分组名称后提交 N0030 系统提示 添加成功 N0040 用例结束 N2 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 添加新的用户 好友 组 输入分组名称后提交 N0030 系统提示 用户 好友 组已经存在 添加失败 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010用户组添加失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 3 4SR F 0030 04 删除用户 好友 组删除用户 好友 组 需求描述需求描述 已经登陆的用户可以删除用户 好友 组 执行者执行者 OU 优先级优先级 4 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 选中准备删除的用户 好友 组后提交 N0030 系统提示 删除成功 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010用户组删除失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 3 5SR F 0030 05 删除用户 好友 删除用户 好友 需求描述需求描述 已经登陆的用户可以删除用户 好友 执行者执行者 OU 优先级优先级 4 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 选中准备删除的用户 好友 后提交 N0030 系统提示 删除成功 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010用户删除失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 3 6SR F 0030 06 修改用户 好友 修改用户 好友 需求描述需求描述 已经登陆的用户可以修改用户 好友 好友备注 执行者执行者 OU 优先级优先级 4 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 选中准备修改的用户 好友 后提交 N0030 系统提示 修改成功 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010用户修改失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 3 7SR F 0030 07 修改用户 好友 组修改用户 好友 组 需求描述需求描述 已经登陆的用户可以修改用户 好友 组 组名 执行者执行者 OU 优先级优先级 4 使用频度使用频度 中 前置条件前置条件 C0010 用户已经登陆成功 后置条件后置条件 正常过程正常过程 N1 N0010 OU 在登陆后 可以看到自己已经分好组的好友列表 N0020 OU 选中准备修改的用户 好友 组后提交 N0030 系统提示 修改成功 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010登陆后 好友列表加载失败 E2 E0010用户修改失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 4SR F 0040 好友聊天好友聊天 本功能模块主要是为了 OU 与好友进行聊天 达到即时通讯 用户数据操作用例图如下 4 1 4 1SR F 0040 01 与好友进行通讯与好友进行通讯 需求描述需求描述 已经登陆的用户可以与好友进行通讯 执行者执行者 OU 优先级优先级 5 使用频度使用频度 高 前置条件前置条件 C0010 好友列表已经加载完成 后置条件后置条件 正常过程正常过程 N1 N0010 OU 选中准备进行聊天的好友 N0020 弹出聊天对话框 N0030 进行聊天通讯 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010OU 与好友不能连接不上 端口 E0020 线程一直处于阻塞中 E0030 OU 与服务器无故断开 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 4 2SR F 0040 02 发送图片发送图片 需求描述需求描述 正在进行通讯 OU 可以给好友发送图片 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 OU 与好友处于通讯状态 后置条件后置条件 正常过程正常过程 N1 N0010 OU 与好友正在进行聊天 N0020 OU 选择图片以预览的形式发送给好友 N0030 发送成功 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010OU 与好友不能连接不上 端口 E0020 线程一直处于阻塞中 E0030 OU 与服务器无故断开 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 4 3SR F 0040 03 保存聊天记录保存聊天记录 需求描述需求描述 正在进行通讯 OU 可以给保存聊天记录 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 OU 与好友处于通讯状态 后置条件后置条件 正常过程正常过程 N1 N0010 OU 与好友正在进行聊天 N0020 OU 点击保存聊天记录后 可以把当前聊天窗口的记录写入指定的地址 N0030 提交后 系统显示 保存成功 N0040 用例结束 N2 N0010 OU 与好友正在进行聊天 N0020 OU 点击保存聊天记录后 可以把当前聊天窗口的记录写入指定的地址 N0030 提交后 系统显示 保存失败 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010OU 与好友不能连接不上 端口 E0020 线程一直处于阻塞中 E0030 OU 与服务器无故断开 E0040 向系统写入文件错误 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 N2 无异常 V0020 用例结束 4 1 4 4SR F 0040 03 查看聊天记录查看聊天记录 需求描述需求描述 正在进行通讯 OU 可以给查看聊天记录 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 OU 与好友处于通讯状态 后置条件后置条件 正常过程正常过程 N1 N0010 OU 与好友正在进行聊天 N0020 OU 点击查看聊天记录后 弹出窗口显示聊天室记录 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010OU 与好友不能连接不上 端口 E0020 线程一直处于阻塞中 E0030 OU 与服务器无故断开 E0040 向系统读取文件错误 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 5SR F 0050 个人信息设置个人信息设置 本功能模块主要是为了 OU 修改个人信息 用户数据操作用例图如下 4 1 5 1SR F 0050 01 修改个人信息修改个人信息 需求描述需求描述 修改登陆用户的个人信息 执行者执行者 OU 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 用户已登陆 后置条件后置条件 正常过程正常过程 N1 N0010 点击查看个人信息 加载个人信息 N0020 选中并修改需要修改的属性 N0030 保存并提交 N0040 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010加载个人信息失败 E0020 提交后 系统显示 操作失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 1 6SR F 0060 系统信息的发送 待定 系统信息的发送 待定 本功能模块主要是系统向用户发送信息 用户数据操作用例图如下 4 1 6 1SR F 0060 01 系统发送信息系统发送信息 需求描述需求描述 系统向已登陆的用户发送信息 执行者执行者 系统管理员 优先级优先级 3 使用频度使用频度 中 前置条件前置条件 C0010 系统管理员已登陆 后置条件后置条件 正常过程正常过程 N1 N0010 系统管理员在公告窗口中输入相关的信息 N0020 发送给在线的其他客户 N0030 用例结束 可选过程可选过程 无 异常过程异常过程 E1 E0010 提交后 系统显示 操作失败 特殊需求特殊需求 无 验收准则 验收准则 V1 V0010 执行正常过程 N1 无异常 V0020 用例结束 4 2性能需求性能需求 无 4 3质量属性需求质量属性需求 4 3 1可靠性可靠性 4 3 1 1STEM01 Q 0010 无缺陷性需求无缺陷性需求 需求描述需求描述 1 同行评审率 纳入配置管理的工作产品的同行评审率应达到 100 2 代码测试覆盖率 语句覆盖率应达到 100 条件覆盖率应达到 95 3 需求测试覆盖率 100 4 测试用例覆盖率 100 优先级优先级 5 4 3 1 2STEM01 Q 0020 健壮性需求健壮性需求 需求描述需求描述 所有的参数都要指定一个缺省值 当输入数据丢失或无效时 自动使用缺 省值 4 3 1 3IM Q 0050 平均修复时间平均修复时间