海纳20需求规格说明书V12.docx

资源描述

海纳20需求规格说明书V12.docx

《海纳20需求规格说明书V12.docx》由会员分享，可在线阅读，更多相关《海纳20需求规格说明书V12.docx（66页珍藏版）》请在冰豆网上搜索。

海纳20需求规格说明书V12.docx

海纳20需求规格说明书V12

海纳2.0需求规格说明书

版本<1.2>

修订历史记录

日期

版本

描述

作者

2010-4-19

1.0

创建文档

吴建荣

2010-4-22

1.1

根据内部讨论意见补充完善

吴建荣

2010-4-26

1.2

根据故事板进行修改

吴建荣

1.引言7

1.1文档目的7

1.2文档范围7

1.3阅读对象7

2.产品概述8

2.1项目背景8

2.1.1立项依据8

2.1.2产品应用范围8

2.1.3系统开发的意义8

2.1.4系统开发的可行性8

2.1.5词汇表8

2.2总体结构9

2.3与其他系统关系10

2.4系统界面统一约束10

2.5异常处理统一规范11

2.6数据存储统一规范11

2.7假设依赖关系11

2.8验收标准11

3.业务流程12

3.1业务流程图12

3.1.1海纳2.0整体业务流程12

3.2业务子流程说明14

3.2.1用户登录子流程14

3.2.2修改密码子流程15

3.2.3精编业务子流程16

4.用例分析18

4.1功能模块结构18

4.1.1X5客户端18

4.1.2海纳应用服务器20

5.各用例详细说明22

5.1X5客户端23

5.1.1登录客户端23

5.1.2修改密码24

5.1.3插入模块25

5.1.4搜索资源数据27

5.1.5资源导航36

5.1.6收藏资源数据38

5.1.7插入资源数据39

5.1.8替换资源数据40

5.1.9调整资源数据40

5.1.10删除资源数据41

5.1.11复制42

5.2海纳应用服务器43

5.2.1资源数据服务43

5.2.2语义解析服务45

5.2.3资源类型服务46

5.2.4个人库服务48

5.2.5新增个人模块数据48

5.2.6查询个人模块数据49

5.2.7删除个人模块数据50

5.2.8收藏个人资源数据52

5.2.9查询个人资源数据53

5.2.10删除个人资源数据54

5.3扩展模块56

6.非功能性要求56

6.1非功能性要求56

6.2海纳应用服务端软硬件要求57

6.3WOS平台服务的软硬件要求57

6.4应急处理要求57

1.引言

本文档是对“海纳2.0”的需求中所提及功能的业务描述，确定海纳2.0的各个组成部分、使用角色、功能模块。

文档目的

本文档描述了“海纳2.0”的业务需求以及系统主体架构。

文档范围

文档明确了“海纳2.0”的各部分需求，清晰、明确的表述该项目所需要的系统架构、客户端框架，以及可以为用户提供的各类功能服务。

阅读对象

文档的阅读对象为系统设计、开发和测试、需求评审、技术管理人员。

2.产品概述

项目背景

立项依据

详见《海纳2.0-技术可行性分析报告V1.2.doc》。

产品应用范围

海纳2.0主要是面对媒体网站和传统媒体的编辑，为编辑在新闻内容的精编方面提供丰富多彩的资源，把编辑从耗费大量的时间来搜索组织各种资源素材中解放出来，从而使得编辑更加专注于其核心业务。

系统开发的意义

系统开发的可行性

参考《海纳2.0-技术可行性分析报告V1.2.doc》

词汇表

详见《海纳2.0-词汇表》

词汇

释义

备注

资源类型

指WOS平台目前所提供的各种资源的名称，比如公开言论、公开事件等。

海纳产品线2.0中，面向编辑提供内容精编的产品的代号

WOS

互联网智能计算平台，通过对外提供的接口为各种应用提供各种智能计算服务以及资源数据服务等

CMS

内容管理系统，网站用于建站所使用，编辑通过该系统进行内容的发布和修改

总体结构

图1总体概述图

总体结构说明：

海纳2.0，在结构上有客户端和服务器，WOS平台则为海纳应用提供智能支撑。

在X5型号中，将采用B/S的架构，用户通过浏览器来使用X5的各种功能，X5的各种功能，通过flex技术展示给用户。

与其他系统关系

1、海纳应用服务器：

海纳2.0需要在后台有一个海纳应用服务器，来处理海纳的业务应用以及运营运维等方面的事务；并且需要公司的WOS平台为海纳2.0提供强大的智能计算支撑。

目前的海纳应用服务器已经存在的有：

运营平台（客户/用户管理）

2、CMS：

客户的发布系统，需要从发布系统的正文编辑器中获取纯文本的正文内容。

系统界面统一约束

对本产品中的所有系统界面，均遵照以下统一约束，在后续的用例分析中不再叙述。

如用例中有特殊需求，在用例中详细描述。

序号

统一约束

异常处理统一规范

在本产品中的所有触发动作，都需要进行异常处理，异常处理机制如下：

1、当出现异常时，需要捕获异常原因，并写入日志文件；

2、在Web系统中，出现异常时，需要在界面上显示该异常的原因，并尽量让人理解，如难以说明，应提示：

系统异常，请联系管理员。

数据存储统一规范

海纳用户的个性数据，将统一存储在海纳应用服务器的数据库上。

假设依赖关系

1、海纳2.0在客户和用户的管理注册上，依赖于海纳应用服务器的运营平台。

2、从用户的发布系统，启动海纳X5，依赖于客户的发布系统，需要客户的发布系统进行开发

验收标准

需要由产品部提供验收标准。

3.业务流程

业务流程图

海纳2.0整体业务流程

图表1-海纳2.0-X5功能业务流程图

图表2-海纳2.0-X5业务数据流图

图表3-海纳应用服务器服务图

业务子流程说明

用户登录子流程

编辑用户在本机打开X5之后（注：

从CMS点击精编），需要用户进行登录（邮箱和密码以及验证码），如果用户已经在当前机器上登录成功，则直接进入到X5的精编界面。

如果用户是第一次使用X5，则需要用户首先进行修改密码才能继续使用。

约束条件：

每个编辑帐号在同一时刻，只能在一个客户端上登录使用。

当编辑在另一个地方重新登录后，那么用该编辑在原来登录的客户端将无法正常使用。

一台机器，在同一种浏览器上，在同一时刻，只能允许一个编辑帐号使用。

当另一个编辑需要在一台已经有编辑正常使用的情况下，在同一种浏览器中使用自己的身份使用时，需要前一个编辑帐户先退出海纳X5。

图表4-用户登录业务流程

修改密码子流程

用户可以在X5中，对自己的登录密码进行修改，确保密码的安全性。

图表5-用户修改密码业务流程

精编业务子流程

用户打开X5后，可以利用海纳提供的资源组件，为当前编辑的内容进行精编。

在X5界面上，用户可以进行简单的搜索或者高级搜索，从而获取符合当前内容的资源。

如果用户对资源效果不满意，可以直接对这些资源内容进行编辑，也可以通过问题反馈把问题提交给海纳的客服人员；当然了，用户也可以通过知识反馈功能，把海纳中还没有的知识点反馈给海纳知识运营人员，知识运营人员对这些知识进行整理后添加到资源库中，以便在后续的搜索中能够搜索到这些知识。

（问题反馈和知识反馈的功能，在本期将不考虑实现）

图表6-内容精编业务流程图

4.用例分析

功能模块结构

海纳2.0包括X5型号以及海纳应用服务器（客户端和服务器），在功能介绍时，将对客户端和服务器分开进行描述。

X5客户端是用户直接使用的工具，在登录后，用户可以使用X5生成和内容相关的资源模块，从而丰富文章的内容。

海纳应用服务器则主要是为X5的功能提供后台服务支撑，包括为海纳客户端提供语义解析服务、资源数据服务等。

X5客户端

X5客户端，是海纳2.0中推出的面向编辑用于内容精编、专题、策划等方面，帮助用户快速进行精编的助手工具。

下图为X5的功能用例图。

图表7-X5客户端功能用例图

X5客户端的主要功能包括：

Ø登录：

根据已经注册的登录邮箱、登录密码（在海纳应用服务器的运营平台上进行注册）和验证码，到海纳应用服务器的运营平台上进行身份的认证。

对于第一次登录的，还要进行密码修改。

Ø修改密码：

在登录后，可以对自己的密码进行修改，确保密码的安全性。

Ø插入模块：

在X5上，用户可以插入一个模块，该模块可以利用海纳提供的资源模板，也可以选择用户以前已经做过的模块，从而生成一个新的模块。

Ø选择已有模块：

在插入模块的界面上，显示该用户以前已经完成的模块，用户可以选择某个模块，进行重新编辑。

（需要利用获取收藏模块的功能显示这些模块）

Ø选择资源模板：

在插入模块的界面上，用户可以选择海纳所提供的某种资源的某个模板来创建一个新的模块。

Ø搜索资源数据：

根据对需要精编的内容进行解析的要素或者用户自己输入的搜索条件，从WOS平台的资源库中搜索满足条件的资源，并且在界面上显示出来。

每次的搜索只针对单个资源进行搜索，并且支持按照资源的时间进行排序。

Ø资源导航：

对本次搜索的结果的关联信息进行导航显示从而缩短资源的范围，便于快速选择需要的资源。

Ø收藏资源：

在搜索数据成功后，可以对感兴趣的资源进行选择，然后把这些选中的资源收藏到海纳应用服务器的个人库中，便于后续重新使用该资源。

Ø插入资源数据：

当进行模块设计时，在搜索资源数据成功后，从这些资源数据中，选择需要的资源，插入到模板规定的地方。

Ø替换资源数据：

当进行模块设计时，对于已经插入的资源数据，可以在选中之后，可以用搜索出来的其它的资源数据进行替换。

Ø删除资源数据：

当进行模块设计时，对于已经插入的资源数据，可以选中某些，点击删除后，从模块中删除。

Ø调整资源数据：

当进行模块设计时，对于已经插入的资源数据，如果觉得某条资源数据不合适，可以选中该资源，然后进行修改，从而模块上可以即时看到修改后的效果。

Ø复制：

当进行模块设计时，如果觉得模块的效果已经达到自己的要求，可以点击复制，把模块数据复制到剪贴板上，然后粘贴到发布系统中。

在复制的同时，也会把该模块数据收藏到个人库中（该动作属于后台自动进行的）。

海纳应用服务器

海纳应用服务器，负责对海纳客户端的业务请求进行处理，包括目前已经有的运营平台，还有本期要开发的业务应用服务器，包括有资源数据服务、个人库服务、语义解析服务。

资源数据服务是指为X5提供资源数据的各种服务，个人库则为用户提供了对个人相关的数据的服务，语义解析服务则为用户提供对文章内容的要素分析服务。

图表8-海纳应用服务器用例图

Ø语义解析服务：

对一篇文章的内容进行语义结构化，提取出文章中提及的人物、时间、空间等要素。

本服务在海纳应用服务器中仅仅是一个转发的过程，转发到WOS平台上进行实际的处理。

Ø资源类型服务：

提供海纳目前已经对外发布的可使用的资源的类型列表。

对于WOS平台所提供的基本资源类型，直接在海纳应用服务器的数据库中体现；对于复合资源模板，则由业务运营人员在海纳应用服务器上注册之后，可以通过该服务返回给用户。

Ø资源数据服务：

根据用户输入的查询条件，获取符合条件的资源数据。

本服务在海纳应用服务器中，根据资源的类型进行处理：

对于基本资源类型，转发给WOS平台进行请求；对于海纳自定义的复合资源（模板），在海纳应用服务器上根据模板的脚本来组织对WOS平台的请求并把所有的资源数据按照模板要求整合后返回给用户。

Ø个人库服务：

本服务主要是为用户的个人信息提供管理服务，包括模块数据以及个人资源的服务。

Ø新增个人模块数据：

当用户在X5上编辑了一个自己满意的模块后，点击复制时，自动把该模块数据通过该功能加入到个人库的模块数据中，方便下次进行查询。

Ø查询个人模块数据：

当用户在X5上插入一个模块时，可以查询自己已经制作的模块，然后在该模块数据的基础上进行重新编辑。

Ø删除个人模块数据：

当用户对自己已经收藏的模块数据不再需要时，可以通过本功能进行删除。

Ø收藏个人资源数据：

用户在X5上搜索到资源数据时，可以对感兴趣的资源数据通过本功能进行收藏。

Ø查询个人资源数据：

用户可以在个人库中搜索自己以前收藏的资源数据，从而提高效率。

Ø删除个人资源数据：

当用户对自己已经收藏的资源数据不再需要时，可以通过本功能进行删除。

Ø资源模板管理：

资源的模块是根据用户的业务需求进行定制的，运营人员可以自己创造出新的模板，并且利用海纳应用服务器进行管理。

Ø资源模板注册：

在海纳应用服务器上注册一个新的资源模板。

当注册了一个资源模板之后，在X5客户端可以通过资源类型服务获取到该资源模板，从而用户可以利用该模板来创建模块数据。

5.各用例详细说明

注：

在本文档中主要通过流程图描述各用例。

X5客户端

登录客户端

概述：

该用例是用户在还没有登录X5时，先用自己的身份在X5上通过验证，以确保可以正常进行后续的业务。

流程图：

图表9-用户登录流程

后置条件：

1、在登录成功后，根据海纳应用服务器所制定的升级策略，加载不同的界面展示（在本期中，拟采用flex技术来进行客户端的展示）

2、用户开始对CMS当前的内容进行精编。

用户在登录时，需要用户的登录邮箱和密码，并加上验证码。

数据名称

最大长度

描述

登录邮箱

64位

用户的唯一标识，符合email的规范

登录密码

32位（字符）

用户的登录密码，输入范围：

6～20位

修改密码

概述：

该用例是用户对自己的密码进行修改，以确保密码的安全性。

前置条件：

1、用户已经登录到X5客户端

流程图：

图表10-修改密码

后置条件：

1、下次登录时，使用修改后的密码。

插入模块

概述：

该用例描述了用户在X5客户端中手动或者自动发起插入一个模块的功能。

该用例在X5客户端中，有三种使用情景，这三种情景，在前置条件中进行描述。

前置条件：

1、用户已经成功登录X5

2、已经正确的从海纳应用服务器获取得到了资源类型列表数据

3、情景1：

用户在CMS上编辑内容时，点击精编（可以选中某种资源类型），自动发起插入模块的动作。

4、情景2：

用户在X5客户端上，觉得效果数据还不够满意时，可以手动点击插入模块，发起插入模块的动作。

5、情景3：

用户在搜索编辑的情景下，觉得需要创建一个模块时，可以手动点击创建模块，发起插入模块的动作。

事件流：

（1）X5客户端弹出模块选择界面，在该界面上有海纳已经提供的资源模板，也有用户自己以前编辑的模块数据（从个人库中获取）。

并且自动根据用户在CMS上的精编下拉资源类型中所选择的资源类型，跳转到该资源对应的模板选择界面。

（2）用户可以选择资源的某个模板，也可以选择以前已经编辑过的某个模块

（3）在X5客户端中，插入一个模块。

在界面上显示模块的效果区域、资源数据搜索区域和资源修改区域。

●如果是选择了以前的模块，在效果区域显示实际的效果，并且在资源数据搜索区域显示该模块对应的资源数据。

●如果是选择了某个资源模板，对于情景1和情景2，自动根据所编辑的内容所解析出来的要素从WOS平台搜索数据。

后置条件：

1、可以重新输入条件进行资源数据的搜索

2、可以对搜索得到的资源数据选择后插入到模块中

3、可以对搜索得到的资源数据进行收藏

4、可以对当前处于编辑状态的模块中的资源数据进行替换和修改

5、可以对当前处于编辑状态的模块中的资源数据进行删除

6、可以在当前处于编辑状态的模块中再次插入一个新的模块