技 术 文 件
技术文件名称:ZXISPCC – IPTV增值业务软件需求说明书_Twitter
技术文件编号:
版 本:
拟 制 李传玖
审 核
会 签
复 审
标准化
批 准
中兴通讯股份有限公司
修改记录
文件编号 | 版本号 | 拟制人/ 修改人 | 拟制日期/ 修改日期 | 更改理由 | 主要更改内容 (写要点即可) |
| A | 李传玖 | 2013-08-15 | 拟制 | 全部 |
|
| 李传玖 | 2013-08-22 | 根据评审意见修改 | 部分章节 |
注:文件第一次归档时,“更改理由”、“主要更改内容”栏写“无”。 |
目 录
1 引言
1.1 编写目的
本文的描述对象是ZXISPCC-IPTV增值业务软件需求说明书(下文简称“本软件”或“软件”)。通过详细描述其功能需求、性能需求、质量属性需求以及其它需求(“外部接口”独立成文),为后续概要设计、软件(系统)测试、用户文档等工作提供基础与约束。
1.2 文档约定
本文档遵循以下约定:
1、 使用的模板是:“软件需求说明书模板V1.0”。
2、 表头文字使用了20%灰度背景;
3、 插图一律使用MS Visio 2003中文版绘制,且是“嵌入”而非“浮于文字上方”。
4、 用同号、同体但加粗的文字来强调需要读者重视的内容。
2 术语、定义和缩略语
2.1 术语、定义
本文使用的专用术语、定义见表2.1,通用术语、定义见<文件编号> 《<XX>术语、定义和缩略语》。
表2.1
术语/定义 | 英文对应词 | 含 义 |
|
|
|
|
|
|
2.2 缩略语
本文使用的专用缩略语见表2.2,通用缩略语见<文件编号> 《<XX>术语、定义和缩略语》。缩略语按其第1个字母顺序排列。
表2.2
缩略语 | 英文原文 | 中文含义 |
<RR> | <Raw Requirements> | <原始需求> |
3 综合描述
3.1 背景
本需求满足IPTV用户从互联网获取视频内容,可扩大内容来源渠道。通过获取Twitter网站内容,充实IPTV社交网络内容。本功能将在海外IPTV局点商用,如美国CBT等。
3.2 软件概述
在TV上集成Twitter应用,实现TV屏上的Twitter消息浏览和消息发送,TVTwitter应用主要通过API和Twitter服务器进行交互,获取和发送消息,API参考地址:
https://dev.twitter.com/docs/api/1.1
TVTwitter应用主要涉及到两部分内容,STB部分和PC部分,STB部分主要负责STB上的Twitter应用展现并且支持用户通过遥控器进行操作,主要包括:ProfileLogin,Profile Logout,Tweet等操作。PC部分主要是用户通过PC浏览器进行Profile帐号的管理包括Profile帐号的新建,修改,Link和删除等操作。
3.3 运行环境
表3.2
名称 | 硬件(CPU/RAM/HD等) | 操作系统及其版本 | 其它软件环境 |
存储系统 | 采用中兴的软硬件一体的云存储服务器系统 |
| 存储系统 |
WEB服务 | 局方提供的通用X86架构服务器 | 根据用户的规模部署。 | WEB服务 |
媒体服务器 | 局方提供的通用X86架构服务器 | 采用中兴的专用的流媒体系统 | 媒体服务器 |
数据库服务器 | 局方提供的通用X86架构服务器 | 采用双机 | 数据库服务器 |
网络设备 | 局方提供的路由器、防火墙或交换机 | 部署四层交换机做负载均衡 | 网络设备 |
中间件 | 1、数据库 2、Suse 11 3、双机软件 | 根据商用部署需求购买 | 中间件 |
数据库服务器 | 局方提供的通用X86架构服务器 | 采用双机 | 数据库服务器 |
B700V2A机顶盒 |
| B700V2A机顶盒 |
|
4 具体需求
IPTV上实现Twitter网站内容获取,包含获取微博内容,发送微博,获取好友列表,粉丝列表等。
4.1 功能需求
4.1.1 Twitter功能
4.1.1.1 SR-F-1001 PC界面创建Profile需求
4.1.1.1.1 SR-F-1001_01登录系统
需求描述:
1、 用户从CBT用户系统跳转到Twitter门户系统,CBT通过HTTPS协议将用户帐号名和其他需要的信息到PC门户维护Profile相关信息页面。
2、 门户页面登录,用户直接使用SNS系统主页进行登录,界面如下:
User name:用户邮箱
Password:用户密码
Validation code:校验码
用户名/密码不用校验
登录流程(参照《Fioptics APP RequirementDescription_V1.7(by linpeng 1030) -副本》):
Login Request: FiOptics App on tablet sendlogin request to CBT-Backend-Authentication-Server with myaccount and password,myaccount likedawn@zteusa.com;
CBT-Backend-Authentication-Serverfinds out all related IPTV accounts according to myaccount.CBT BackendAuthentication Server maintains the mapping between myaccount and IPTVaccounts.
Note:
(1) In addition to IPTV accountsassociated with “myaccount”, CBT-Backend-Authentication-Server needs to pickout user’s IPTV accounts and return them to Fioptics APP.
(2) CBT-Backend-Authentication-Serverreturn the multiple IPTV accounts related to “myaccount” to Tablet. Tabletselects one IPTV account and continues the operation.
Tokenservice procedure on APP side
用户登录以后进入维护Profile相关信息页面,如下图:
界面展现场景:
1、没有Profile用户的情况,只有”Creater New Profile”
2、存在多个多个Profile时,按首字母名称升序进行展示,不分页。
3、在此界面用户可创建、编辑、删除Profile用户。
4、在此界面,每个profile后带Link twitter account链接,
备注:
1、 删除时弹出确认提示框,不需要输入密码:Do you want to delete theprofile?
2、 编辑:用户编辑账户,弹出密码输入框,需要输入密码。
4.1.1.1.2 SR-F-1001_02创建Profile用户
需求描述:
Create NewProfile:创建新Profile
用户头像系统默认给出,绑定Twitter账号后,自动同步Twitter头像到本地Profile。
输入昵称:字母、数字、特殊字符等组成
输入密码:四位数字
link twitter账号(此处为可选)
提交DONE创建用户成功
4.1.1.1.3 SR-F-1001_01编辑Profile用户
需求描述:
Edit Profile:编辑Profile
用户可编辑昵称、修改密码、绑定Twitter账号。已绑定twitter账号,需要绑定其它twitter账号时,需要使用其它profile进行绑定。
4.1.1.1.4 SR-F-1001_01 Link Twitter帐号
需求描述:
用户在PC机上点Link Twitter Account,调用Twitter界面进行profile账号与Twitter账号的绑定。完成后返回当前页。
要求:绑定Twitter账号后,自动同步Twitter头像到本地Profile,作为Profile的个人头像。
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:
可选过程:无
异常过程:
特殊需求:无。
4.1.1.2 SR-F-1002登录界面
需求描述:
Twitter的应用入口放在Menu –>Applications下面,增加Twitter入口:
用户点击Twitter应用进入profile主页,类似如下,最下方增加一句提示信息,提醒用户登录的网址去维护profile信息:
默认焦点会放在左边头像上,左右键可以向左或者向右移动焦点框。当焦点框移动到两端的时候焦点框固定在两端,左右键移动头像,框不动。
备注:
1、界面最多展示三个Profile用户。没有Profile用户时,只有一条提示语。
2、Profile用户按照首字母升序排序,不区分大小写。
3、用户已登录时,右下角加一个绿色对号的方式区分。
用户操作:
A.如用户已绑定Twitter账号,用户输入正确密码后,进入Twitter的首页
B. 如用户未绑定Twitter账号,输入密码前提示用户去PC界面绑定Twitter Account。采用弹出对话框的方式提示。词条:Pleasevisitwww.cincinnatibell.com to link your Twitteraccount. ,要求该词条可以通过配置修改。
C.如果用户密码错误,提示用户密码错误信息:Incorrect Password!同时清空输入框,焦点回到第一个输入框。
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:
可选过程:无
异常过程:
特殊需求:无。
4.1.1.3 SR-F-1003 Twitter
4.1.1.3.1 SR-F-1003_01Home首页
需求描述:
Home:
用户点击相关项目进入详细页面,点击Home,则进入Tweets的详细列表页面,展示格式如下:
用户点击某一条Tweet,按OK按键,再进入Tweet的详细信息页面,展示格式见高保真,会出现针对此Tweet的评论信息,对于多条评论信息,评论展示信息(发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间),分页加载,到下面最后一条展示之后自动加载下一页数据。
Tweet的展示内容包括:发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+View Photo的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
点击详情:
发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+ViewPhoto的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
备注:
1、刷新快捷键(B键Refresh),取最新数据,展示在第一页。
2、分页加载,聚焦到当页最后一条之后按向下键,加载下一页数据。展示当前页。
3、不处理Tweet中的超链接,只显示超链接内容,不能继续点击链接。
4、如果存在多张图时,只展示第一张缩略图,点击后聚焦第一张图片,左右键进行图片切换。
5、展示的详情信息,每条信息等高展示。
A键: New Tweet ,ReTweet
ReTweet转发微博
同Twitter一样,不做任何编辑,直接点击ReTweet,再确认即可转发成功
New Tweet发布微博
用户在Twitter应用直接通过New Tweet发送消息,发送消息窗口形式同VOD页面形式(内容不超过140个字符)
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:N1
可选过程:无
异常过程:
特殊需求:无。
4.1.1.3.2 SR-F-1003_02提到我的人@connect
需求描述:
首页:仅展示Mentions
用户点击mentions,展示@我的信息
展示内容见高保真:
Tweet的展示内容包括:发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+ViewPhoto的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
点击详情:
发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+ViewPhoto的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
备注:
1、刷新快捷键(B键Refresh),取最新数据,展示在第一页。
2、分页加载,聚焦到当页最后一条之后按向下键,加载下一页数据。展示当前页。
3、不处理Tweet中的超链接,只显示超链接内容,不能继续点击链接。
4、如果存在多张图时,只展示第一张缩略图,点击后聚焦第一张图片,左右键进行图片切换。
5、展示的详情信息,每条信息等高展示。
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:N1
可选过程:无
异常过程:
特殊需求:无。
4.1.1.3.3 SR-F-1003_03Trends
需求描述:
用户点击Trends,列出所有的Trends列表,用户点击某Trends之后,则会列出该Trends所有的搜索结果:
点击某具体的Trends条目之后,展示如下:
Tweet的展示内容包括:发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+ViewPhoto的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
点击详情:
发布者Twitter名称,@发布者用户名称,Tweets内容,发布时间。Tweets需要展示文字和图片部分,Tweets列表里面对于有图片的微博,微博内容下一行展示一个图标+ViewPhoto的字样,进入某Tweet详情页面后,展示图片实际大小,但是对于过大的图片需要有个最大尺寸的限制,不能超出电视屏幕的显示。
备注:
1、刷新快捷键(B键Refresh),取最新数据,展示在第一页。
2、分页加载,聚焦到当页最后一条之后按向下键,加载下一页数据。展示当前页。
3、不处理Tweet中的超链接,只显示超链接内容,不能继续点击链接。
4、如果存在多张图时,只展示第一张缩略图,点击后聚焦第一张图片,左右键进行图片切换。
5、展示的详情信息,每条信息等高展示。
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:N1
可选过程:无
异常过程:
特殊需求:无。
4.1.1.3.4 SR-F-1003_04Me个人界面
需求描述:
Tweets(#):主页展示,Tweets(数字),表示用户发布了多少微博,列出用户自己发布的所有的Tweets。用户点击后进入自己的微博列表界面,展示个人所发微博。
Following(#)用户关注人数,展现Following列表,Following表示已关注,对所有关注的用户,展现取消关注,并提供取消关注功能。展示用户头像、昵称、名称,简介(具体参加高保真)。
Follower(#)用户粉丝人数,展现Follower列表,已关注的用户,展现并提供取消关注;未关注的用户,展现并提供关注功能。展示用户头像、昵称、名称,简介(具体参加高保真)。
SwitchAccount:切换到Profile列表,让用户选择不同的Profile登录。
Logout:退出当前登录到登录界面。
Actor:登录用户
优先级:5
使用频度:经常
前置条件:
后置条件:
正常过程:N1
可选过程:无
异常过程:
特殊需求:无。
4.2 性能要求
4.3 质量属性需求
4.3.1 可靠性
4.3.1.1 SR-Q-0010 无缺陷性需求
需求描述:
1) 同行评审率:纳入配置管理的工作产品的同行评审率应达到100%。
2) 代码测试覆盖率:语句覆盖率应达到100%,条件覆盖率应达到95%。
3) 需求测试覆盖率:100%
4) 测试用例覆盖率:100%
优先级:5
4.3.1.2 SR-Q-0020 内部异常健壮性需求
需求描述:系统在出现任何内部异常时,都应释放所有占用的资源。
优先级:5
4.3.1.3 SR-Q-0020 参数健壮性需求
需求描述:所有的参数都要指定一个缺省值,当指定参数丢失或无效时,自动使用缺省值。
优先级:5
4.3.1.4 SR-Q-0030 可用性需求
需求描述:软件的可用性应在7×24小时内达到100%。
优先级:5
4.3.1.5 SR-Q-0050 平均故障间隔时间MTBF。
需求描述:平均故障间隔时间MTBF应不小于9000小时。
优先级:5
4.3.1.6 SR-Q-0060 平均修复时间MTTR。
需求描述:平均修复时间MTTR应小于1小时。
优先级:5
4.3.2 安全性
4.3.2.1 SR-Q-1030 数据一致性需求
需求描述:软件必须在正常工作及发生异常(如掉电、异常退出)的情况下都保持数据间的一致性。如果发生了不一致,应提供工具自动修复。
需要保持一致性的数据及其一致性定义如下:
移动搜索管理平台执行数据和数据库数据一致
优先级:5
验收准则:V1
V0010 用测试程序进行模拟测试。
V0020 重启动移动搜索管理平台,系统应该正常平稳运行,对于终止的业务要能正确的进行错误处理。
4.3.2.2 SR-Q-1040 反修改需求
需求描述:软件应具有判断自身是否被修改(如被病毒感染)的能力。进一步地,如果自身已被修改,则应提醒用户如何进行恢复。
优先级:5
验收准则:V1
V0010 移动搜索管理平台启动的时候应该备份一份配置文件。
V0020 维护人员在移动搜索管理平台运行过程中配置或修改系统配置参数,不应该影响备份的配置文件。
V0030 维护人员可以使用备份配置文件恢复系统到原有运行配置状态上。
4.3.3 可服务性
4.3.3.1 SR-Q-2010 代码可读性需求
需求描述:函数调用不能超过两层深度;每一个软件模块中,注释与源代码语句的比例至少为1 : 2 。
优先级:5
验收准则:V1
V0010 代码走查
V0020 代码统计工具统计结果符合要求
4.3.4 易用性
4.3.4.1 SR-Q-2600 数据编辑完成应有提示
需求描述:对于修改、删除、增加数据的操作,操作完成后应有提示。
优先级:5
4.3.5 可移植性
4.3.5.1 SR-Q-3010 硬件独立性
需求描述:管理平台软件应能独立于硬件环境。
4.3.5.2 SR-Q-3020 软件独立性
需求描述:软件应能不依赖于具体的WEB服务环境。
优先级:5
4.3.6 扩展性
SR-Q-4010 国际化版本其它语种支持。
需求描述:对于国际化版本本期只实现了两种语言,对于UMA多语种支持应该保留对应的扩展能力,对于其它语种的支持,应该能采用堆叠的方式即可实现。
优先级:3
验收准则:略
4.3.7 可测试性
4.3.7.1 SR-Q-5010 日志输出控制
需求描述:在需要时,可以通过配置文件来控制内部关键信息的输出,输出目标也可通过配置文件配置。
优先级:5
验收准则:V1
V0010 修改UMA程序的配置文件中的日志级别,使用测试程序进行模拟测试。
V0020 UMA启动后,根据日志级别的设置,把日志写进日志文件。
V0030 设置的日志级别不同,日志文件的详细程度不同。
4.4 其它需求
4.4.1 通用化、系列化、模块化需求
需求描述:在设计时应借用表4.1所列的模块,并提供表4.2所列的模块。
表4.1
序号 | 借用的模块名称 | 借用的模块代码 |
1 | 通用权限模块 |
|
2 | 日志模块 |
|
3 | 数据库访问模块 |
|
表4.2
序号 | 提供的模块名称 |
|
|
优先级:5
验收准则:V1
V0010 满足模块化开发需要,加快编码进度,开发需在30工作日内完成
4.4.2 设计和实现上的限制
4.4.2.1 设计和实现上的一般限制
无
4.4.2.1.1 SR-M-1010 必须使用的技术
无
4.4.2.1.2 SR-M-1020 必须采用的专利
无
4.4.2.2 SR-M-2010 设计和实现上的用户界面限制
无
4.4.2.3 SR-M-3010 包装盒必须环保及可回收
需求描述:软件包装盒必须满足如下企标要求:
a) Q/ZX 12.208 《禁止和限制使用的环境物质要求》;
b) Q/ZX 12.209 《无铅元器件认证技术要求》;
优先级:5
4.4.3 执行标准
无
4.4.4 国际化
4.4.4.1 SR-M-3020 语种相关的国际化需求
需求描述:本软件有表4.1所列的语种相关的国际化需求。“√”表示应支持对应的语种,而“-”则无需支持。
表4.10[CDS1]
类型 | 名 称 | 语 种 | 备注 | ||
中文 | 英语 |
| |||
文 档 | 技术手册 | √ |
|
| 无 |
安装手册 | √ |
|
| 无 | |
操作维护手册 | √ |
|
| 无 | |
各类宣传资料 | √ |
|
| 无 | |
各类培训资料 | √ |
|
| 无 | |
|
|
|
|
| |
实 现 | 联机帮助 | √ |
|
| 无 |
调试信息 | - |
|
| 无 | |
日志 | √ |
|
| 无 | |
输入(如配置文件) | - |
|
| 无 | |
输出(如报告) | √ |
|
| 无 | |
界面 | √ |
|
| 无 | |
|
|
|
|
| |
其它 | 实现方式 | 动态设置,立即刷新。界面应根据具体语种进行调整 | |||
键盘布局 | 采用操作系统设置,无需特别考虑 | ||||
文字方向 | 采用操作系统设置,无需特别考虑 | ||||
排序 | 采用操作系统设置,无需特别考虑 | ||||
时间日期格式 | 采用操作系统设置,无需特别考虑 | ||||
|
|
|
|
|
4.4.5 杂类需求
无
5 体验收准则
1、 配置文档资料齐全,并通过评审。
2、 软件通过测试部系统测试,并可以发布。
6 参考文献
《Youtube需求-Open API方案-V1.0》
《YouTube API应用说明》
[CDS1]4.10?