产品入门指南优化是什么?
产品入门指南是京东云产品帮助文档的重要组成部分,该文档通过Step-by-Step的可操作步骤,帮助用户在短时间内(通常1小时)顺利使用京东云产品完成特定任务。售前团队通过实际动手使用产品,对产品的入门指南提出具体改进建议,形成改进版本,并在和对应的产品经理达成共识后,发布到京东云官网。
为什么需要进行产品入门指南优化?
- 京东云产品入门指南是帮助用户通过动手实际操作,快速了解和使用京东云产品的主要文档;
- 某些产品的入门指南操作性不强,导致用户不能按入门指南在短时间(1小时)内顺利体验京东云产品;
- 售前团队在学习京东云产品时,产品入门指南是最重要的文档,也能对文档的不足和改进点有最深刻的体会。
产品入门指南优化分工
| 云产品 | 负责人 | 新入门指南目录 | 产品经理和ERP | 入门指南标题 | 状态 | 现入门指南URL |
|---|---|---|---|---|---|---|
| API网关 | 张佳 | apig | 钟晓兰zhongxiaolan | |||
| 云搜索Elasticsearch | 张佳 | es | 马琳malin63 | |||
| 资源编排(Resource Orchestration) | 熊炜(西区) | ro | 罗蕾luolei29 | |||
| 日志服务 | 熊炜(西区) | log | 张闻杰zhangwenjie30 | |||
| 分布式数据库TiDB | 李锐(南区) | tidb | 尹兴涛yinxingtao | |||
| 原生容器(Native Container) | 董仕超 | nc | 李保斗libaodou | |||
| 流数据总线 | 刘冀 | stream-hub | 李硕lishuo26 | |||
| 流计算 | 刘冀 | stream-compute | 李硕lishuo26 | |||
| 云编译 | 李兵 | codebuild | 咏梅yongmei | |||
| 云部署 | 李兵 | codedeploy | 刘蕊liurui115 | |||
| Web应用防火墙 | 杨敏强 | waf | 张景峰zzjf | 利用京东云WAF实现网站应用7层防护 | 进行中 | https://docs.jdcloud.com/cn/web-application-firewall/prepare |
| IP高防 | 杨敏强 | ipanti | 向玥xiangyue3 | 未开始 | https://docs.jdcloud.com/cn/anti-ddos-pro/overview | |
| 密钥管理服务 | 杨敏强 | kms | 安宏奎anhongkui | 未开始 | 官网无link |
每个产品的入门指南包括如下状态说明:
- 未开始:未启动任何产品入门指南相关工作,包括使用现有产品、确定入门指南辩题等;
- 进行中:表示着手进行入门指南编写和修改工作,并在git中不断更新变化;
- 已发布:表示通过和对应的产品经理沟通,在达成共识后发布到京东云官网(docs.jdcloud.com)
产品入门指南编写指导原则
在优化京东云产品入门指南时,应遵循如下原则:
- 目的性:入门指南不是简单的产品操作手册,而是需要首先明确对用户有价值的目标,然后再通过使用京东云产品的特定功能到达这一目标;
- 可操作性:入门指南是一个动手操作指南,读者基于该指南能动手实践完成特地任务;
- 时间短:除了入门指南所需的前提准备外(前提准备需明确相关指南),基于该指南完成所有操作的时间不易超过1小时;
- 避免资源浪费:入门指南中如何涉及到付费资源,最后应包含资源清除方法,避免不必要的云资源费用。
入门指南编写规范
- 为了便于可发布到京东云文档官网,建议采用Markdown编写;
- 文档格式可参考AWS的文档规范。https://docs.aws.amazon.com/general/latest/gr/docconventions.html
- 可参考AWS的产品入门指南范例:Getting Started Using Elastic Beanstalk https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/GettingStarted.html
版权声明
本文仅代表作者观点,不代表百度立场。
本文系作者授权百度百家发表,未经许可,不得转载。

