【项目需求说明书文档模板】WEB即时通讯规格说明书
说明书
WEB即时通讯规格说明书
说明+需求+规格
详细模板联系我邮箱:lcyangmi@163.com
保密声明
本方案的内容属于个人、公司(XXXX)的知识财产,属于机密文档,将被限制做进一步的传播。接受并阅读本方案,表明客户方同意并接受本方案中的内容不得传播于客户公司之外,其阅读和传播范围仅限于客户公司内,或与本项目有关的参与工作和评估的人员。在未经本人的书面认可和允许,任何个人,机构复制、拷贝或引用本方案的任何片断或全部内容,无论通过电子形式或非电子形式,用于其他用途的行为被认为是侵犯公司财产和知识产权的行为。
项目说明书 |
文档编号 |
WEB-IM130325-1.0.0 |
|||||
项目代号 |
W-IM1.00 |
项目名称 |
嵌入式IM即时通讯 |
产品版本 |
V1.0.0 |
||
文档名称 |
WEB即时通讯规格说明书 |
||||||
审核人 |
杨密 |
审核时间 |
2013-04-14 |
页数 |
65 |
密级 |
机密 |
编写人 |
杨密 |
编写时间 |
2013-03-15 |
状态 |
审核完成 |
目 录
1 引言 4
1.1 文档目的 4
1.2 读者对象 4
1.3 阅读说明 4
1.4 文档范围 4
2 开发环境 4
1.4 开发环境 4
1.4 正式环境 4
3 术语、定义和结构图 4
3.1 术语、定义 4
3.2 缩略语 5
4 设计概述 5
4.1 背景 5
4.2 软件概述 5
4.3 运行环境 5
4.4 用户类及其要求 6
5 系统详细需求 7
5.1 功能需求 7
5.1.1 W-IM1.00-0010 登陆平台启动即时通讯客服端 7
5.1.2 W-IM1.00-0020 更改用户在线状态 8
5.1.3 W-IM1.00-0030 好友列表和好友分组 13
5.1.4 W-IM1.00-0040 用户与好友聊天 16
5.1.5 W-IM1.00-0050 个人信息设置 20
5.1.6 W-IM1.00-0060 系统信息的发送 22
5.1.6 W-IM1.00-0060 聊天记录 25
5.1.6 W-IM1.00-0070 可能认识的好友 29
5.1.6 W-IM1.00-0080 查看好友信息 33
5.1.6 W-IM1.00-0090 获取帮助聊天记录 34
5.2 性能需求 38
5.3 质量属性需求 42
5.3.1 可靠性 43
5.3.2 可维护性 44
5.3.3 可移植性 45
5.3.4 扩展性 46
5.3.5 可测试性 47
5.4 外部接口需求 48
5.5 其它需求 53
6 总体验收准则 55
7 数据字典 60
8 参考文献 65
1 引言
业务功能点分三期开发,本文档详细介绍了一期开发的需求和规格信息,一期功能点主要有:登陆平台启动即时通讯客服端、更改用户在线状态、好友列表和好友分组、用户与好友聊天、个人信息设置、系统信息的发送、聊天记录、可能认识的好友、查看好友信息、获取帮助聊天记录;
二期拓展开发语音支持和学堂支持等功能点;
三期拓展邮件发送、平台定制、平台互动等;
1.1 文档目的
本文档详细描述了WEB即时通讯的说明、需求、规格文档提供的基础和约束;嵌入式开发,融合项目产品,同步数据与信息,实现跨域,即时信息等必要需求;
1.2 读者对象
预期的读者和阅读建议参见表1.1。
表1.1
读者分类 |
阅读重点 |
备注 |
项目经理 |
全文,并据此编制/修订项目(软件)开发计划等。 |
审核 |
设计与开发工程师 |
需求的完整性、正确性、可行性、优先级、无二义性,为概要设计作准备。 |
|
售前、售后工程师/用户代表 |
需求的必要性、优先级,并据此准备市场资料。 |
|
测试工程师 |
需求的可验证性,并据此准备(软件)系统测试方案。 |
|
文档工程师 |
全文,为编写用户文档作准备。 |
此项无 |
1.3 阅读说明
文档阅读说明,设计文档背景定义,文档注意事项;
1) 表头文字使用了20%灰度背景;
2) 图像文件使用截图加说明,项目数据见截图;
3) 以加粗的形式或者是标亮的形式表示重点;
4) 非必要说明处以略或不详、暂无说明;
5) 择重说明:以序号代表重点。
优先级的取值为:5、4、3、2、1,
定义如下:
表1.2
编号 |
描述 |
5 |
是必须的,它规定了产品的必备需求。没有这些需求,产品将不能完成用户的工作,从而也就无法达到市场的准入条件。 |
4 |
是重要的,它规定了那些竞争对手已经实现且用户感觉很好的需求、本产品区别于其它同类产品的独特需求及其它一些需求。只有完成这些需求,才能使本产品有市场竞争力。 |
3 |
是应该的,它规定了当前版本可以不做,但必须在未来版本中实现的需求。此种需求对产品的体系结构影响可能较大,因此必须在系统设计时予以考虑。 |
2 |
是可能的,它规定了那些有了会更好但没有也没有什么关系的需求,如一些提高效率的小工具。 |
1 |
是备忘的,它规定了我们想象的但目前无法或无需实现的需求。 |
1.4 文档范围
本方案的内容属于个人、公司(XXXX)的知识财产,属于机密文档,将被限制做进一步的传播。接受并阅读本方案,表明客户方同意并接受本方案中的内容不得传播于客户公司之外,其阅读和传播范围仅限于客户公司内,或与本项目有关的参与工作和评估的人员。在未经本人的书面认可和允许,任何个人,机构复制、拷贝或引用本方案的任何片断或全部内容,无论通过电子形式或非电子形式,用于其他用途的行为被认为是侵犯公司财产和知识产权的行为。
2 开发环境
2.1 开发环境
操作系统:Windows
WEB服务器:tomcat
J2EE服务器:tomcat
数据库服务器:Mysql
开发语言:JAVA 1.5
集成开发环境:MYECLIPSE, Dreamweaver 8
此系统开发所采用的开发环境的选择即保证了系统性能,又能最到程度地保证了系统的通用性和标准性。MYECLIPSE作为集成开发环境是JAVA平台上最为流行,也是功能最为强大的工具,并且MYECLIPSE集成了众多的第三方插件为系统开发提供了非常巨大的支撑。
2.2 正式环境
操作系统:Linux
WEB服务器:tomcat
J2EE服务器:tomcat
数据库服务器:Mysql
开发语言:JAVA 1.5
*此处不在集群范围内
3 术语、缩略语和结构图
3.1 术语
本文使用的专用术语、定义见表2.1:
表2.1
术语/定义 |
英文对应词 |
含 义 |
需求 |
requirement |
指“被描述系统(SuD ,System Under Description)“做什么”(功能需求)及“做什么”时的水平(非功能需求,如性能需求、质量属性需求、外部接口需求、其它需求)。这个通俗定义是针对技术需求的,而非技术需求(如进度的限制)一般不在本文档中给出(一般放在研制任务书/项目计划中)。 |
3.2 缩略语
本文使用的专用缩略语见表2.2:
表2.2
缩略语 |
英文原文 |
中文含义 |
RR |
Raw Requirement |
原始需求 |
UR |
User Requirement |
用户需求 |
WEBIM |
Instant Messaging |
WEB即时通讯 |
JDK |
Java Development Kit |
Java开发工具包 |
JRE |
Java Runtime Environment |
Java 运行环境 |
JVM |
Java Virtual Machine |
Java 虚拟机 |
UC |
User Case |
用例 |
DBS |
Database Server |
数据库服务 |
OU |
Ordinary Users |
普通用户 |
3.3 结构图
图3.1
4 设计概述
4.1 应用背景
嵌入式WEB即时通讯架构,是以JAVA为基础实现的聊天系统,主要包括:在线聊天,修改个人信息,添加好友,查找好友,好友分组等功能模块。
图4.1
4.2 软件概述
以下概述了本功能点的所有业务需求和需求的级别
表4.1
功能点 |
权重 |
描述 |
1v1(One to One) |
5 |
1对1的聊天模式,简单的点对点 |
添加好友(AF) |
5 |
添加好友,站内用户数据添加好友 |
好友分组 |
3 |
实现好友的分组 |
修改个人信息 |
3 |
站内数据修改个人信息,同步站内数据 |
查找好友 |
4 |
实现站内好友查找,展开数据 |
用户状态设置 |
4 |
设置常见用户的状态;1.在线 2.离开 3.隐身 4.离线 |
群组设置 |
5 |
支持群组聊天 |
最近联系人 |
3 |
查看最近联系人 |
4.3 运行环境
嵌入式网站开发,如当前微博中好友信息的及时通讯聊天技术;
4.4 用户类别与说明
表4.2
序号 |
名 称 |
说 明 |
1 |
超级用户 |
系统的超级用户(Adminstrator)超级管理员 |
2 |
官方用户 |
系统的官方用户(客服、官方助手、官方博士) |
3 |
系统名家用户 |
系统的名家用户 |
4 |
系统机构用户 |
系统的机构用户 |
5 |
系统付费用户 |
系统的付费用户,改用户由平台支持用户金额 |
6 |
系统企业用户 |
系统企业用户 |
7 |
普通用户 |
普通用户 |
8 |
游客用户 |
无注册用户,游客 |
5 系统详细需求
5.1 功能需求
5.1.1 W-IM1.00-0010 登陆平台启动即时通讯客服端
登录平台,启动通讯,登录用户数据通过跨域获取,数据在平台抓取;
登录成功显示主界面,列出所有数据;
登陆用例图如下:
5.1.1.1 W-IM1.00-0010-01 显示主界面
名称 |
显示主界面 |
编号 |
W-IM1.00-0010-01 |
功能描述 |
显示主界面,加载好友信息 |
||
优先级 |
5 |
||
输入 |
点击展开/显示主界面 |
||
操作序列 |
1、 点击展开 2、 显示主界面 3、 加载数据 |
||
输出 |
显示好友数据和在线状态 |
||
补充说明 |
显示好友数据按优先排列,机构、企业、名人用户显示置顶 |
需求描述:显示主界面
执行者:用户
优先级:5
使用频度:高
前置条件:
C0010 系统管理员已启动即时通讯服务端及DBS。
后置条件:
正常过程:
N1
N0010 用户在系统中输入用户名及密码;
N0020 提交数据后,平台进入主界面;
N0030 展开主界面,显示好友数据和在线状态(包括好友的在线状态)
N0040 用例结束。
可选过程:
无
异常过程:
E1
E0010 提交后,系统提示”操作失败”
E2
E0010 提交后,系统提示“未连接上服务器”
特殊需求:
无
验收准则:V1
V0010 执行正常过程N1,N2,无异常;
V0020 用例结束。
5.1.2 W-IM1.00-0020 更改用户在线状态
5.1.2.1 W-IM1.00-0020-01 更换在线状态
5.1.3 W-IM1.00-0030 好友列表和好友分组
5.1.3.1 W-IM1.00-0030-01 展示好友列表
5.1.3.2 W-IM1.00-0030-02 添加新好友
5.1.3.3 W-IM1.00-0030-03 添加用户(好友)组
5.1.3.4 W-IM1.00-0030-04 删除用户(好友)组
5.1.3.5 W-IM1.00-0030-05 删除用户(好友)
5.1.3.6 W-IM1.00-0030-06 修改用户(好友)
5.1.3.7 W-IM1.00-0030-07 修改用户(好友)组
5.1.4 W-IM1.00-0040 用户与好友聊天
5.1.4.1 W-IM1.00-0040-01 与好友进行通讯
5.1.4.2 W-IM1.00-0040-02 发送图片
5.1.5 W-IM1.00-0050 个人信息设置
5.1.5.1 W-IM1.00-0050-01 修改个人信息
5.1.6 W-IM1.00-0060 系统信息的发送
5.1.6.1 W-IM1.00-0060-01 系统发送信息
5.1.7 W-IM1.00-0070 聊天记录
5.1.7.1 W-IM1.00-0040-03 保存聊天记录
5.1.7.2 W-IM1.00-0040-03 查看聊天记录
5.1.8 W-IM1.00-0080 可能认识的好友
5.1.9 W-IM1.00-0090 查看好友信息
5.1.10 W-IM1.00-0100 获取帮助
5.2 性能需求
无
5.3 质量属性需求
5.3.1 稳定性
5.3.1.1 STEM01-Q-0010 无缺陷性需求
需求描述:
1) 同行评审率:纳入配置管理的工作产品的同行评审率应达到100%。
2) 代码测试覆盖率:语句覆盖率应达到100%,条件覆盖率应达到95%。
3) 需求测试覆盖率:100%
4) 测试用例覆盖率:100%
优先级:5
5.3.1.2 STEM01-Q-0020 健壮性需求
需求描述:所有的参数都要指定一个缺省值,当输入数据丢失或无效时,自动使用缺省值。
5.3.1.3 IM-Q-0050 平均修复时间MTTR。
需求描述:平均修复时间MTTR应小于2小时。
5.3.1.4 IM-Q-0060 异常记录需求
需求描述:当发生异常时,软件应能记录操作系统版本、可用硬盘空间、最大物理内存及可用内存、用户的输入、错误类型;软件应能连续记录异常数据。
5.3.1.5 IM-Q-0070 数据一致性需求
需求描述:软件必须在正常工作及发生异常(如掉电、异常退出)的情况下都保持数据间的一致性。如果发生了不一致,应提供工具自动修复。
5.3.1.6 IM-Q-0080 反修改需求
需求描述:软件应具有判断自身是否被修改(如被病毒感染)的能力。进一步地,如果自身已被修改,则应提醒用户如何进行恢复。
5.3.2 维护性
5.3.2.1 IM-Q-0090 代码可读性需求
需求描述:函数调用不能超过两层深度;每一个软件模块中,注释与源代码语句的比例至少为1 : 2 。
5.3.3 移植性
5.3.3.1 IM-Q-0100 硬件独立性
需求描述:软件应该无视(服务器)硬件环境,在任何(服务器)硬件环境可以正常运行。
5.3.3.2 IM-Q-0110 软件独立性
需求描述:软件应该无视操作系统,在任何支持JRE5.5以上系统的中可以正常运行。
5.3.4 扩展性
需求描述:软件可以提供接口,让用户通过第三方接入的方法。
5.3.5 测试性
5.3.5.1 IM-Q-0120 日志输出控制
需求描述:在需要时,可以通过配置文件来控制内部关键信息的输出,输出目标也可通过配置文件配置。
5.4 外部接口需求
暂无
5.5 其它需求
暂无
6 总体验收标准
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) 总体验收测试应在一个月内作出结论。
7 数据字典
8 参考文献
参考文献见...
转载于:https://my.oschina.net/yami/blog/132612
【项目需求说明书文档模板】WEB即时通讯规格说明书相关推荐
- 软件需求说明书(文档模板)
软件需求说明书(文档模板)- - 其中的数据描述部分在实际工作中比较少涉及. 在上一次的文档中增加新模块 业务需求,详细描述为 现状.业务概述.业务组成.业务描述.业务流程. 功能需求也相应作了扩充, ...
- 《信息化项目文档模板二——项目启动会文档模板》
系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...
- EMA—项目 需求设计文档
(实习公司给的练习项目,想法是,试着做一个完整的项目,体验一次完整的项目流程,从项目前期的文档攥写,包括需求文档.设计文档等,以及项目中期的具体编码,以及项目后期的维护更新等流程,写写博客,总结提升~ ...
- 软件需求规格说明书--文档模板
{ 产品名称} 软件需求规格说明书 编 写 人 : 编写日期 : 年 月 日 文档修订记录 版本编号 说明:如形成文件.变更内容 ...
- 概要设计说明书--文档模板
一. 引言 1. 编写目的 从该阶段开发正式进入软件的实际开发阶段,本阶 段完成系统的大致设计并明确系统的数据结构与软件结构.在软件设计阶段主要是把一个软件需求转化为软件表示的过程,这种表示只是描绘出 ...
- android app文档,android App项目需求描述文档.docx
本app是给外卖配送员用的,系统后台根据一定的逻辑生成或者建立运单,本App读到后台的运单讲外卖送到定外卖的手中 本文档所需详细资料请到/s/1jGGgtLG下载 与后台交互的地方不用实现,有数据显示 ...
- 产品需求报告文档模板
状态 : [ √] 草稿 [] 修改中 [ ] 定稿 文件标签: 产品需求文档.XXX 版本: 作者: 日期: 编辑历史 文件名称: XXX 产品需求文档 文件说明: 编辑历史: 编辑时间 版本 作 ...
- 详细设计说明书--文档模板
1 引言 1.1编写目的 说明编写这份详细设计说明书的目的,指出预期的读者. 1.2背景 说明: a.待开发软件系统的名称: b.本项目的任务提出者.开发者.用户和运行该程序系统的计算中心. 1.3定 ...
- java需求设计文档模板下载_设计Java
设计JavaTag内容描述: 1.北华大学开放实验报告实验项目名称: JAVA程序综合设计(数据库设计) 所属课程名称: 面对象程序设计JAVA 实 验 类 型: 设 计 型 班 级: 信 息112 ...
最新文章
- 「golang」panic: commands out of sync. Did you run multiple statements at once
- 最短路径树 php,CCNA-开放式最短路径优先(OSPF)真实考题
- 小明学习Linux运维课后习题实战A
- python多线程与GIL
- 思科研究称80%的指纹认证机制均可遭绕过
- 基本数据类型与字符串之间的转换
- java 绘制动态波形图6,折线图波形图绘制(动态绘制,实时变化)
- rocketmq生产者发送到哪个队列
- 大疆aeb连拍_大疆进军运动相机领域,发布OSMO?ACTION,对标GoPro
- 【数据结构实验】单链表实验
- 第九届蓝桥杯决赛大学A组
- 组态王软件自动邮件EMAIL发送
- 去除xp桌面图标阴影
- Spring Boot 中yml文件小图标不正确解决方案
- 用Unity3D开发一个题库系统
- PowerDesigner中pdm设置1:n,1:1,n:n的对应关系
- 超级棒的一个DP问题详解(入门)
- Linux实战(一):服务器应用迁移
- html中奇数偶数判断,js中判断奇数或偶数
- 单片机驱动DM542步进电机(使丝杠做往返运动--速度可调)
热门文章
- Kooboo CMS - Html.FrontHtml[Helper.cs] 各个方法详解
- 微信公众号商业化有哪些盈利模式?
- 锦佰安科技副总裁杨海青:AI行为识别身份认证助力移动金融支付安全
- 基于阿里云物联网的无人值守远程农业智慧盒DIY之(二)太阳能-蓄电池板的树莓派供电系统。
- 摒弃传统观念,展现女性德才
- c语言用栈将单链表逆置,写一算法:借助于栈将一个单链表逆置
- 从一个简单的AT模式事务例子入手
- 邀请逝者参加Party? Facebook道歉并利用AI改进推送机制
- Android Gradle 的配置从 Groovy 迁移到 KTS
- speedoffice(Excel)怎么对图片进行垂直翻转