脊柱脊髓损伤Taobao产品需求说明书(规格最全的PRD)

2021年1月28日发(作者：陆军总医院)


PRD

文件编号

文档版本




SPI-doc-

TIP-PRD
V0.6
作


者

最后修改日期

黑羽

2009/1/20



版本号
0.6


TOP
接入系统
(Taobao
Intergration Platform)
产品需求说明书








编

写

人：

黑羽



编写时间：


2009/1/20








PRD






修订控制页

编号

1
文档版本

V0.1
修订章节

1-7
修订原因

创建

修订日期

2008.12.22


2
V0.2

5.2.1-5.2.5
根据
NCP
和
平台组会议
修改

3
V0.3
5.1
–
5.2
根据
29
日周一
TOP
架
构讨论会，
划分清
TIP
的需求优先级、子系统
结构而调整

4
V0.4

5.1
消息中心类
型添加，
API
监控调用管
理

5
V0.5
1.1,
5.1.1
，
5.1.2
根据会议批
注内容补充
和完善

6
V0.6
1.1-1.4,
修订

2009/1/20
黑羽

2009.1.16
黑羽

2009.1.8
黑羽

2009.1.5
黑羽

2008.12.28
黑羽



黑羽

修订人












第
2
页

共
30
页



PRD

5.1.2,5.2.1
7
8
9
10
























第
3
页

共
30
页



PRD

目






录

1

概述
.................... .................................................. .................................................. ...................
6

1.1

1.2

1.3

1.4

2

名词说明

.
............................ .................................................. ........................................
6

产品概述及目标

.
......................... .................................................. ...............................
6

产品
roadmap
.
....................... .................................................. ......................................
7

产品风险

.
............................ .................................................. ........................................
7

使用者需求

.
........................... .................................................. .................................................
8

2.1

需求描述

.
...... .................................................. .................................................. ............
8

3

4

可选方案

.
............................ .................................................. .................................................. ..
8

效益成本分析

.
............. .................................................. .................................................. .........
8

4.1

4.2

4.3

效益预测

.
................ .................................................. .................................................. ..
8

产品技术中心成本

.
........... .................................................. .........................................
9

非产品技术中心的支持成本

.
.......... .................................................. ..........................
9

5

功能需求

.
............................ .................................................. ..................................................
1
0

5.1

5.2

5.3

5.4

功能总览

.
................ .................................................. ..................................................
1
0

功能详情

.
............. .................................................. .................................................. ...
1
1

整合需求

.
......... .................................................. .................................................. .......
2
7

BETA
测试需求

.< br>............................................... .................................................. ........
2
8

6

非功能需求
.
........................................... .................................................. ...............................
2
8

产品营销需求

.
.......................... .................................................. ............................................
2
8

规则变更需求

.
........... .................................................. .................................................. .........
2
8

产品服务需求

.
. .................................................. .................................................. ...................
2
8

法务需求
.
........................................... .................................................. ...................................
2
9

财务需求

.
............................ .................................................. ..................................................
2
9

帮助需求

.
............. .................................................. .................................................. ...............
2
9

安全性需求

.
.............................................. .................................................. ............................
2
9

7

上、下线需求

.
................ .................................................. .................................................. ....
2
9

7.1

7.2

上线时限需求

.
.......................... .................................................. ................................
2
9

下线需求（活动类需求必须明确下线时间）

.................. .......................................
2
9

8

运营计划

.
... .................................................. .................................................. .....................
3
0






第
4
页

共
30
页



PRD

请与以下部门讨论
PRD
序号

1.


OK
？

部门

□

运营中心：

商城、集市、
二手闲置、
门
户

□

运营中心：
网
站运营

?

?

?

?

?

?

?

?

客户中心：
客
?

服服务部

?

?

客户中心：
网
?

络安全部

产
品
技
术
中
?

心：
系统分析
?

师

虚拟团队

?

?

产
品
技
术
中
?

心：
项目经理

?

?

产
品
技
术
中
?

心：
用户体验
?

设
计
之
交
互
设计师

财
务
分
析
中
?

心：财务组

?

财务分析部：
?

数据分析组

行
政
管
理
中
?

心：法务部

?

规则委员会

?

支付宝

?

阿里软件

?

沟通内容

协助设定产品的
RaodMap
协助设定
target customer
：使用者

协助评估：营销
/
推广需求

协助设定商业目标

协助设定产品的
RaodMap
协助设定
target customer
：使用者

协助评估：营销
/
推广需求

协助设定商业目标

讨论客服如何支持：客服需求

协助评估诈欺
/
数据窜改风险：欺诈
/
数据窜改风险、
不
当使用风险

预测客服成本、工作量

评估安全性

讨论以确定方案的规模评估、推出计划

进行技术可行性分析，提出关键问题的技术解决方案

评估系统规模，数据量，所需资源等

协助评估风险

协助确定产品发布日期

协助确定产品成本

协助评估风险

协助制作
Demo
协助确定

use flow
：用户使用方式


2.


3.


□

4.


5.


□

□

6.


□

7.


□

8.


9.


10.


□

□

□

请评估财务需求

协助评估风险

协助确定如何度量产品目标

协助评估法务问题并检视合作伙伴：
使用者数据需求、

法务需求、

版权、隐私权等需求

协助评估风险：诈欺
/
数据窜改风险、

不当使用风险

协助评估规则变更的影响

协助确定接口、合作方式等

协助确定接口、合作方式等

11.


12.


13.



□

□

□



第
5
页

共
30
页



PRD

1

概述

1.1

名词说明

介绍本文档中会使用到的专用名词，如：新名词、产品内实体单位，请尽量使用大众可理解
的名词


名称

开放平台

说明

以开放< br>OpenAPI
为核心的服务开放系统。包括开放数据、开放平台
和开放的业务方入口。

TOP
App
全称

: T
aobao Open Platform,
淘宝开放平台

应用，
本文中指由第三方开 发的，
需要调用淘宝
TOP
来完成业务的应
用程序。通常表现为浏览器端的页 面插件，桌面端的应用程序。

ISV
Role
Independent Software Vender
，

独立软件开发商。

业务方角 色，对应于不同的
API
访问权限和监控策略。包括：买家、
卖家、高级卖家等

TPS
每秒业务处理量。

1.2

产品概述及目标

请以三到五段文字摘要说明您所提出的新服务
(
包 含推出新产品、
现有产品重新设计或升级、
现有服务推出新功能
)
及目标；请 包括：

1
、

产品背景说明；

淘宝开放平台是 建立大淘宝的关键要素之一。
以围绕淘宝开放数据和业务为核心，
把握商业
趋势，以第 三方开发软件为助力，建立繁荣的商业生态圈。

对于外部数据的调用和监管，
是淘宝 开放中最重要的环节之一。
同时，
在可预见的外部数据
调用大规模增长时，淘宝开放平 台也必须拥有适应的机制。这些就是
TIP(
淘宝接入平台
)
的
商业 背景和需求。


2
、

产品的目标客户；

从
TIP
系统的使用来说，有外部客户和内部用户



第
6
页

共
30
页



PRD

外部用户：第三方开发者通过开发的
App
对< br>TIP
平台发出数据调用请求。

内部用户：
a)
开发者社区。

开发者通过开发者社区系统向
TIP
平台请求相关< br>App
管理
接口和开发者管理接口。

b) Admin Center
。

AdminCenter
使用方为淘宝小二。
Admin Center
主要 用于管理开放平
台的开发者、
App
、
API
；统计分析
T OP
数据调用的情况。

1.3

产品
roadmap
请描述产品发展的各个阶段，可以用图表等多种方式表述。

产品发展阶段

1
阶段描述

?

满足外部数据调用的基本（
P1
）需求

?

实现基本的监控、管理功能

?

对
App
和开发者有最基本的管理，
支持
Admin Center
对单个
ISV
单个应用手工纳入
TIP
管理体系。

?

Admin
Center
有基本的
ISV
管理界面，和数据统计
分析

时间

2009
年
3
月

2
?

完善监控与管理。
（完成相关
P2
需求）
。

2009
年
6
?

完善
App
和开发者管 理，支持对批量的
ISV
批量应
月

用纳入
TIP
管理体系。

?

建立初步消息通知机制

?

Admin Center
完善
ISV/App
管理界面，数据统计

?

支持开发者社区批量接入第三方开发者

?

?

?

?

App
和开发者管理支持第三方草根开发者。

2009
年
10
将沙箱环境使用结合进
TIP
的相关申请
/
管理流程

月

支持开发者社区对第三方草根开发者的开放。

Admin < br>Center
完成半自动化的管理，集合对淘宝
Hosting
程序的相关支持


3
1.4

产品风险

请描述产品可能存在的风险，比如商务谈判的风险？外部合作的风险？不当使用的风险

等
等。

风险级别为高中低。

风险

风险级别

描述




监控策略




改善策略




（
// TBD
）









第
7
页

共
30
页



PRD

2

使用者需求

2.1

需求描述
< br>请说明此产品的目标客户、其需求及使用情境。如已做好
personas(
代表性角色 描述
)
，也请
包含于此。

请详细说明此产品主要的使用案例
—
目标客户最想由此产品满足什么需求？最想藉由此产
品解决什么问题？
—
并根据每个不同的使用案例，区别目标客户及其使用时的优先级
/
重要
性
/< br>频率。

目标客户





需求描述



场景描述

优先级



3

可选方案

列出所有可以选择的达到该产 品目标的方案要点（主要思路）
，给各方案适当的评价，并推
荐最优方案。

如另有说明可选方案的文档，欢迎使用。


方案
1
方案
2
方案
3



方案介绍




优点




缺点

4

效益成本分析

4.1

效益预测

请提供在各种产品环境中的效益预测，
并标明主要的变量及假设，
最好能包含现在和过去的
效益数据。

示例：

指标
1
环境


时间

网游每日支付宝成交额

好


中


差


现状



第
8
页

共
30
页



PRD

产品发布
后一周

产品发布
后
3
周







4.2

产品技术中心成本

请列出设计及部署此产品的产品技术中心所需的资源需求，包括人力成本，软硬件支出等。

（项目经理应提供协助）

示例：

人力资源

产品经理

开发

测试



非人力资源

硬件投入

软件投入

其他


成本（元）





描述







工作内容描述



成本（人日）






备注






交互设计师


4.3

非产品技术中心的支持成本

请预估此产品有关的除产品技术部以外的支持投入。

比如：
需要客服部投入 多少的资源用于该产品的服务，
需要运营部投入多少的资源运营该产
品。

示例：

人力资源

客服专员

运营专员





非人力资源

广告位

邮件群发



工作内容描述






成本（元）




成本（人日）






描述





备注






第
9
页

共
30
页



PRD




5

功能需求

请详细说明此产品主要功能及内容
(
除了使用者所需的功 能外，也请说明公司内部操作及维
护产品所需要的功能或工具，
例如报表、
管理使用者 或者维护网站内容的工具、
客户服务工
具等等。

5.1

功能总览

请分别列出所有重要的功能及内容模块。

建议使用图表来形象阐述本产品各个组成部分的关系。

功能总表

名称

1.
TIP Router +Gateway
描述

淘宝接入平台网关：

?

分发外部程序调用淘宝业务数据的请求。

?

监控、记录和限制外部调用请求

?

主动通知应用程序信息


2.
Taobao
Manager
Intergration
淘宝平台集成管理器：

?

提供管理开发者接口，用于监控和规范他们开
发行为，并划分等级。

?

提供管理
App
信息接口，监控和调整
App
使
用状态；与
API
调用或权限控制

?

提供管理
API
订购状态接口

?

区分
API
使用角色，
和其他
TIP
子系统协作共
同限制业务角色的各种 权限。


3.
TIP Admin Center
淘宝服务调用管理中心：

?

小二人工管理和调整开发者，
API
，
APP
的后
台工具

?

展示 淘宝各项服务的调用情况的图表报告。
含
开发者、
API
、
APP< br>等相关数据。



1

1

优先级

备注

1



第
10
页

共
30
页



PRD

5.2

功能详情

5.1.1

TIP
服务接入

TIP
的服务接入 需要处理外部业务数据请求、支持应用能够注册和侦听消息，同时还要进行
业务数据调用的监控，以及对 自身性能的监控。

5.1.1.1

业务数据请求

?

简要说明

验证外部数据请求合法性，再将请求转发给相关
OpenAPI
或内部系统。


?

业务规则


序号

1.


优先级

需求名称

1
验证请求合法性

需求描述

?

验证
App
身份和状态

?

验证
App
是否在
TIM
中合法注册

?

验证
App
状态是否是正常使用状态

?

业务方身份合法性

?


?

验证会话
session
合法性

?

本次会话是否真实有效

?

会话是否过期

?

传入参数是否有效

?

验证
App
请求是否越权

?

当前
Ap p
请求的
API
与其在
TIM
中注册的
API
权限 范围是否相符

?

当前
App
请求的
API与终端用户在
TIM
中注册的角色权限范围是
否相符

?

验证调用方是否在黑名单中

?

App
是否在黑名单中

?

域名或
IP
地址是否在黑名单中

?

终端用户是否在黑名单中

2.



四种会话验证机制

根据
App
在申请时，
申请的
API
权限范围和使用描述，
第一期由小二决定
App
对应下列那一种应用方 式。并和这种方式绑定。


?

固定时间
SessionKey
当
App
应用需要在固定时间内运 行时，
使用这一种方式授权访问时间。


?

根据访问延迟
Sessionkey
避免用户在短时间内重复登录，影响软件运作和用户体验

?

两次调用间隔不超过
15
分钟时，自动延长
15
分钟



第
11
页

共
30
页



PRD

?

15
分钟之内，没有有效调用，会话失效


?

使用一次失效
Sessionkey
单次调用后即失效，如同买家功能中订单确认。每次确认都需要认证
一次。


?

通知失效
SessionKey
会话一直有效，除非由我们主 动终止。场景：一个与淘宝对接的
ERP
系统一直监控订单的状态。



3.


1
业务方身份验证

?

当所调用请求需要终端用户登录时，调用相关验证程序来验证用户身
份。 相关验证程序，在本期表现为：

?

弹出的一个

域内的浏览器窗口

?

内含账户名和密码输入框

?

保证用户输入账户和密码的安全性

?

将合法
API
请求转发给相应
OpenAPI
?

将
OpenAPI
返回的数据对象按调用方要求的格式返回

?

支持常用的数据格式

?

XML
?

JSON
?

易于扩展成其他数据格式。

4.


5.


1
1
转发请求

返回数据的格式

?

?

?

?

?


界面原型




执行者

应用程序
(App)
前置条件


后置条件


主流程


?

用户在客户端的
App
中登录

?

根据
App
类型生成相应的
Session
机制

?

App
从客户端发起数据请求

?

Gateway
返回
OpenAPI
访问结果





第
12
页

共
30
页



PRD

5.1.1.2

消息中心

?

简要说明

由
Gatew ay
将相关业务信息，
主动通知给业务调用方。
如，
续费，
订单状态 改变、
暂停，
特殊通知

?

业务规则


序号

1.


优先级

需求名称

2
需求描述

提供消息通知机制
< br>Gateway
可以通过主动调用
App
回调接口，传输消息中心注册过的消息 类
型。

消息中，包括：

?

消息类型

?

业务数据：

?

其余必需数据：时间戳等

典型应用场景：

一个大商家的自动订单处理系统：

一旦用户的某个订单付款了，
Gatew ay
立刻调用自动订单处理系统服务器
的回调接口，发出“已付款”类型消息给它，内含：
消息类型：已付款

业务数据：订单号，订单相关信息

必需数据：时间戳

订单处理系统立刻开始进入后续业务——发货流程。

同理，之后，还有“已确认收货”与财务系统的对接，如，划入应收账款
等。

消息类型

?

订单

?

“等待买家付款”

?

“价格已修改”

?

“买家已付款，等待卖家发货”

?

“卖家已发货，等待买家确认”

?

“订单成功”

?

“订单取消”

?

商品

?

上架

?

下架

?

售完

?

库存报警

?

服务状态

?

到期，停止服务

服务恢复正常

由于消息通知机制系统开销成本较高，初期有限制的开放给高级开发者 和
特殊大商家角色使用。


?

对于开发者的限制：


第
13
页

共
30
页

2.


2
3.


2
使用消息接口的限
制




PRD

只有
4
星级以上才可以调用接口

?

对于用户的限制：

?

买家：高级用户

?

卖家：高级卖家

4.


5.


2
2
提供消息注册接口

?

规范
App
注册侦听某些类型事件
(Event)
的方法

?

规范
App
提供的回调接口

消息类型注册和撤
销

使用方为淘宝小二和淘宝自己的其他管理程序

?

消息中心需提供注册新事件的接口，规范事件的数据格式和规范。

?

消息中心需提供撤销某事件的接口，供取消事件。


?

?

?

?

?


界面原型




执行者


前置条件


后置条件


主流程


?

当
App
注册相关应用侦听时，传入商家号

?

该商家的订单或者商品变动时，查找需要接受此消息的
App
列表

?

由
Gateway
按列表逐一调用
App
回调接口




5.1.1.3

监控和性能

?

简要说明

服务接入过程中，
需要实现性能扩展性、< br>子系统独立互不干扰；
有效的记录服务接入情
况；监控和管理接入使用。

?

业务规则


序号

1.


优先级

需求名称

1
性能

需求描述

?

扩展性

由于独立网店的推广，和 其他业务推广，在可预计将来
OpenAPI
访问
量的增长将会很迅速。

TIP Gateway
必须具备易于扩展的软硬件结构来适应这种快速增长。

?

子系统互不干扰

?

一个子系统的性能或者状态发生变化时，不会影响其余系统
API

第
14
页

共
30
页




PRD

的正常。


2.


1
日志

?

记录
OpenAPI
调用情况

?

日志异步记录

?

至少保留
3
个月的记录

?

记录黑名单、性能监控的相关数据

?

提供日志相关接口

?

提供给
Admin Center
使用

?

提供给开发者社区等其他子系统调用（不建议）

?

日志记录内容：

?

当前时间

?

api_key
?

app_path
?

业务方
id
?

客户端
IP
地址

?

app
请求的
content-type
?

app
请求的
body length
?

service
名称

(
对应的
API
名称
)
?

uri：包含
path
和
method_name
，不包含
servi ce_name
，如：
/list/getMember
；

?

service
返回的状态码

?

service
返回的
content-type
?

service
响应时间

?

service
返回的
body length
?

gateway
响应状态码


?

设置外部调用的黑名单。一旦调用方落在黑名单中，将失去数据访问
权。

?

黑名单的分级

?

暂时失效：

禁止权限
2
小时，之后自动从黑名单中消除。

加入和消除时间记录入日志

?

固定失效：必须调用解禁接口，才会从黑名单中消除

?

提供黑名单的对外接口

?

供
Admin Center
调用

?

供其他子系统、其他部门调用

?

实时监控
(
延迟
<=5
分钟
)
?

每分钟内单个
AppKey
或终端用户调用频率明显异常时：

?

自动加入黑名单，设为“暂时失效”

?

将相关信息记录入日志

?

每分钟内部分接口的性能反映异常（错误码）
、挂起时

?

自动调用
Admin Center
相关接口

?

将相关信息记录入日志

?

分时段统计监控


第
15
页

共
30
页

3.


2
黑名单

4.


1
性能监控