PRD文档资料资料标准模板资料.doc
《PRD文档资料资料标准模板资料.doc》由会员分享,可在线阅读,更多相关《PRD文档资料资料标准模板资料.doc(29页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、-+文件编号SPI-doc- TIP-PRD作者黑羽文档版本V0.6最后修改日期2009/1/20版本号0.6TOP接入系统(Taobao Intergration Platform)产品需求说明书编 写 人: 黑羽 编写时间: 2009/1/20 -+修改记录:版本号修改人修改日期审核人批准人备注V1.02016.07.20创建确认签字:序号版本号内容日期批准人备注1V1.0 2345-+目 录1概述51.1名词说明51.2产品概述及目标51.3产品roadmap51.4产品风险62使用者需求62.1需求描述63可选方案64效益成本分析74.1效益预测74.2产品技术中心成本74.3非产品技
2、术中心的支持成本85功能需求85.1功能总览85.2功能详情105.3整合需求115.4BETA测试需求116非功能需求11产品营销需求11规则变更需求12产品服务需求12法务需求12财务需求12帮助需求13安全性需求137上、下线需求137.1上线时限需求137.2下线需求(活动类需求必须明确下线时间)138运营计划13请与以下部门讨论PRD序号OK?部门沟通内容1.运营中心:商城、集市、二手闲置、门户n 协助设定产品的RaodMapn 协助设定target customer:使用者n 协助评估:营销/推广需求n 协助设定商业目标2.运营中心:网站运营n 协助设定产品的RaodMapn 协助
3、设定target customer:使用者n 协助评估:营销/推广需求n 协助设定商业目标3.客户中心:客服服务部n 讨论客服如何支持:客服需求n 协助评估诈欺/数据窜改风险:欺诈/数据窜改风险、不当使用风险n 预测客服成本、工作量4.客户中心:网络安全部n 评估安全性5.产品技术中心:系统分析师 虚拟团队n 讨论以确定方案的规模评估、推出计划n 进行技术可行性分析,提出关键问题的技术解决方案n 评估系统规模,数据量,所需资源等n 协助评估风险6.产品技术中心:项目经理n 协助确定产品发布日期n 协助确定产品成本n 协助评估风险7.产品技术中心:用户体验设计之交互设计师n 协助制作Demon
4、协助确定 use flow:用户使用方式 8.财务分析中心:财务组n 请评估财务需求n 协助评估风险9.财务分析部:数据分析组n 协助确定如何度量产品目标10.行政管理中心:法务部n 协助评估法务问题并检视合作伙伴:使用者数据需求、 法务需求、 版权、隐私权等需求n 协助评估风险:诈欺/数据窜改风险、 不当使用风险11.规则委员会n 协助评估规则变更的影响12.支付宝n 协助确定接口、合作方式等13.阿里软件n 协助确定接口、合作方式等1 概述1.1 名词说明介绍本文档中会使用到的专用名词,如:新名词、产品内实体单位,请尽量使用大众可理解的名词名称说明开放平台以开放OpenAPI为核心的服务开
5、放系统。包括开放数据、开放平台和开放的业务方入口。TOP全称 : Taobao Open Platform, 淘宝开放平台App应用,本文中指由第三方开发的,需要调用淘宝TOP来完成业务的应用程序。通常表现为浏览器端的页面插件,桌面端的应用程序。ISVIndependent Software Vender, 独立软件开发商。Role业务方角色,对应于不同的API访问权限和监控策略。包括:买家、卖家、高级卖家等TPS每秒业务处理量。1.2 产品概述及目标请以三到五段文字摘要说明您所提出的新服务(包含推出新产品、现有产品重新设计或升级、现有服务推出新功能)及目标;请包括:1、 产品背景说明;淘宝开
6、放平台是建立大淘宝的关键要素之一。以围绕淘宝开放数据和业务为核心,把握商业趋势,以第三方开发软件为助力,建立繁荣的商业生态圈。对于外部数据的调用和监管,是淘宝开放中最重要的环节之一。同时,在可预见的外部数据调用大规模增长时,淘宝开放平台也必须拥有适应的机制。这些就是TIP(淘宝接入平台)的商业背景和需求。2、 产品的目标客户;从TIP系统的使用来说,有外部客户和内部用户外部用户:第三方开发者通过开发的App对TIP平台发出数据调用请求。内部用户:a) 开发者社区。 开发者通过开发者社区系统向TIP平台请求相关App管理接口和开发者管理接口。b) Admin Center。 AdminCente
7、r使用方为淘宝小二。Admin Center主要用于管理开放平台的开发者、App、API;统计分析TOP数据调用的情况。1.3 产品roadmap请描述产品发展的各个阶段,可以用图表等多种方式表述。产品发展阶段阶段描述时间1l 满足外部数据调用的基本(P1)需求l 实现基本的监控、管理功能l 对App和开发者有最基本的管理,支持Admin Center对单个ISV单个应用手工纳入TIP管理体系。l Admin Center有基本的ISV管理界面,和数据统计分析2009年3月2l 完善监控与管理。(完成相关P2需求)。l 完善App和开发者管理,支持对批量的ISV批量应用纳入TIP管理体系。l
8、建立初步消息通知机制l Admin Center完善ISV/App管理界面,数据统计l 支持开发者社区批量接入第三方开发者2009年6月3l App和开发者管理支持第三方草根开发者。l 将沙箱环境使用结合进TIP的相关申请/管理流程l 支持开发者社区对第三方草根开发者的开放。l Admin Center完成半自动化的管理,集合对淘宝Hosting程序的相关支持2009年10月1.4 产品风险请描述产品可能存在的风险,比如商务谈判的风险?外部合作的风险?不当使用的风险 等等。风险级别为高中低。风险风险级别描述监控策略改善策略(/ TBD)2 使用者需求2.1 需求描述请说明此产品的目标客户、其需
9、求及使用情境。如已做好personas(代表性角色描述),也请包含于此。请详细说明此产品主要的使用案例目标客户最想由此产品满足什么需求?最想藉由此产品解决什么问题?并根据每个不同的使用案例,区别目标客户及其使用时的优先级/重要性/频率。目标客户需求描述场景描述优先级3 可选方案列出所有可以选择的达到该产品目标的方案要点(主要思路),给各方案适当的评价,并推荐最优方案。如另有说明可选方案的文档,欢迎使用。方案介绍优点缺点方案1方案2方案34 效益成本分析4.1 效益预测请提供在各种产品环境中的效益预测,并标明主要的变量及假设,最好能包含现在和过去的效益数据。示例:指标1网游每日支付宝成交额环境时
10、间好中差现状产品发布后一周产品发布后3周4.2 产品技术中心成本请列出设计及部署此产品的产品技术中心所需的资源需求,包括人力成本,软硬件支出等。 (项目经理应提供协助)示例:人力资源工作内容描述成本(人日)备注产品经理交互设计师开发测试非人力资源成本(元)描述硬件投入软件投入其他4.3 非产品技术中心的支持成本请预估此产品有关的除产品技术部以外的支持投入。比如:需要客服部投入多少的资源用于该产品的服务,需要运营部投入多少的资源运营该产品。示例:人力资源工作内容描述成本(人日)备注客服专员运营专员非人力资源成本(元)描述广告位邮件群发5 功能需求请详细说明此产品主要功能及内容(除了使用者所需的功
11、能外,也请说明公司内部操作及维护产品所需要的功能或工具,例如报表、管理使用者或者维护网站内容的工具、客户服务工具等等。5.1 功能总览请分别列出所有重要的功能及内容模块。建议使用图表来形象阐述本产品各个组成部分的关系。功能总表名称描述优先级备注1. TIP Router +Gateway淘宝接入平台网关:l 分发外部程序调用淘宝业务数据的请求。l 监控、记录和限制外部调用请求l 主动通知应用程序信息12. Taobao Intergration Manager淘宝平台集成管理器:l 提供管理开发者接口,用于监控和规范他们开发行为,并划分等级。l 提供管理App信息接口,监控和调整App使用状态
12、;与API调用或权限控制l 提供管理API订购状态接口l 区分API使用角色,和其他TIP子系统协作共同限制业务角色的各种权限。13. TIP Admin Center淘宝服务调用管理中心:l 小二人工管理和调整开发者,API,APP的后台工具l 展示淘宝各项服务的调用情况的图表报告。含开发者、API、APP等相关数据。15.2 功能详情5.1.1 TIP服务接入TIP的服务接入需要处理外部业务数据请求、支持应用能够注册和侦听消息,同时还要进行业务数据调用的监控,以及对自身性能的监控。5.1.1.1 业务数据请求l 简要说明验证外部数据请求合法性,再将请求转发给相关OpenAPI或内部系统。l
13、 业务规则App上架流程参考:1. ISV资格申请2. 沙箱测试3. 小二审核4. 正常发布序号优先级需求名称需求描述1.1验证请求合法性l 验证App身份和状态n 验证App是否在TIM中合法注册n 验证App状态是否是正常使用状态l 业务方身份合法性合法状态包括哪几种可能考虑:沙箱阶段正式使用阶段nl 验证会话session合法性n 本次会话是否真实有效n 会话是否过期n 传入参数是否有效l 验证App请求是否越权n 当前App请求的API与其在TIM中注册的API权限范围是否相符n 当前App请求的API与终端用户在TIM中注册的角色权限范围是否相符l 验证调用方是否在黑名单中n App
14、是否在黑名单中n 域名或IP地址是否在黑名单中n 终端用户是否在黑名单中2.四种会话验证机制根据App在申请时,申请的API权限范围和使用描述,第一期由小二决定App对应下列那一种应用方式。并和这种方式绑定。l 固定时间SessionKey当App应用需要在固定时间内运行时,使用这一种方式授权访问时间。l 根据访问延迟Sessionkey避免用户在短时间内重复登录,影响软件运作和用户体验l 两次调用间隔不超过15分钟时,自动延长15分钟l 15分钟之内,没有有效调用,会话失效l 使用一次失效Sessionkey单次调用后即失效,如同买家功能中订单确认。每次确认都需要认证一次。l 通知失效Ses
15、sionKey会话一直有效,除非由我们主动终止。场景:一个与淘宝对接的ERP系统一直监控订单的状态。3.1业务方身份验证l 当所调用请求需要终端用户登录时,调用相关验证程序来验证用户身份。相关验证程序,在本期表现为:n 弹出的一个域内的浏览器窗口n 内含账户名和密码输入框l 保证用户输入账户和密码的安全性4.1转发请求l 将合法API请求转发给相应OpenAPI5.1返回数据的格式l 将OpenAPI返回的数据对象按调用方要求的格式返回l 支持常用的数据格式n XMLn JSONl 易于扩展成其他数据格式。l 界面原型l 执行者应用程序(App)l 前置条件l 后置条件l 主流程 n 用户在客
16、户端的App中登录n 根据App类型生成相应的Session机制n App从客户端发起数据请求n Gateway返回OpenAPI访问结果5.1.1.2 消息中心l 简要说明由Gateway将相关业务信息,主动通知给业务调用方。如,续费,订单状态改变、暂停,特殊通知l 业务规则序号优先级需求名称需求描述1.2提供消息通知机制Gateway可以通过主动调用App回调接口,传输消息中心注册过的消息类型。消息中,包括:l 消息类型l 业务数据:l 其余必需数据:时间戳等典型应用场景:一个大商家的自动订单处理系统:一旦用户的某个订单付款了,Gateway立刻调用自动订单处理系统服务器的回调接口,发出“
17、已付款”类型消息给它,内含:消息类型:已付款业务数据:订单号,订单相关信息必需数据:时间戳订单处理系统立刻开始进入后续业务发货流程。同理,之后,还有“已确认收货”与财务系统的对接,如,划入应收账款等。2.2消息类型l 订单n “等待买家付款”n “价格已修改”n “买家已付款,等待卖家发货”n “卖家已发货,等待买家确认”n “订单成功”n “订单取消”l 商品n 上架n 下架n 售完n 库存报警l 服务状态n 到期,停止服务服务恢复正常3.2使用消息接口的限制由于消息通知机制系统开销成本较高,初期有限制的开放给高级开发者和特殊大商家角色使用。l 对于开发者的限制:只有4星级以上才可以调用接口
18、l 对于用户的限制:n 买家:高级用户n 卖家:高级卖家4.2提供消息注册接口l 规范App注册侦听某些类型事件(Event)的方法l 规范App提供的回调接口5.2消息类型注册和撤销使用方为淘宝小二和淘宝自己的其他管理程序l 消息中心需提供注册新事件的接口,规范事件的数据格式和规范。l 消息中心需提供撤销某事件的接口,供取消事件。l 界面原型l 执行者l 前置条件l 后置条件l 主流程 n 当App注册相关应用侦听时,传入商家号n 该商家的订单或者商品变动时,查找需要接受此消息的App列表n 由Gateway按列表逐一调用App回调接口5.1.1.3 监控和性能l 简要说明服务接入过程中,需
19、要实现性能扩展性、子系统独立互不干扰;有效的记录服务接入情况;监控和管理接入使用。l 业务规则序号优先级需求名称需求描述1.1性能l 扩展性由于独立网店的推广,和其他业务推广,在可预计将来OpenAPI访问量的增长将会很迅速。TIP Gateway必须具备易于扩展的软硬件结构来适应这种快速增长。l 子系统互不干扰n 一个子系统的性能或者状态发生变化时,不会影响其余系统API的正常。2.1日志l 记录OpenAPI调用情况n 日志异步记录n 至少保留3个月的记录l 记录黑名单、性能监控的相关数据l 提供日志相关接口n 提供给Admin Center使用n 提供给开发者社区等其他子系统调用(不建议
20、)l 日志记录内容: 当前时间 api_key app_path 业务方id 客户端IP地址 app请求的content-type app请求的body length service名称 (对应的API名称) uri:包含path和method_name,不包含service_name,如:/list/getMember;由凤先评估 service返回的状态码 service返回的content-type service响应时间 service返回的body length gateway响应状态码3.2黑名单l 设置外部调用的黑名单。一旦调用方落在黑名单中,将失去数据访问权。l 黑名单的分级n
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- prd 文档 资料 标准 模板
限制150内