首页 / 新闻

01.

06

2017

Transpedia的发布及其使用攻略

技术博客

Transpedia是星环随TDH 4.6发布的手册在线同步网站。我们希望通过它拓宽用户查阅手册的渠道,提升文档浏览检索的方便性。

解决的问题

Transpedia出现之前,支持论坛(support.transwarp.cn)是星环科技主要的文档发布平台,它提供了各个手册pdf版本的下载链接。需要文档时,用户必须先下载,然后再对手册进行浏览或查询。这种文档维护方式存在两大严重缺陷。

首先是限制了消息传播的实时性。随着产品的不断更新迭代,相应产品的使用手册也在进行着快速更改。由于消息的不对称,用户可能无法及时获知手册的更新消息,并及时下载新版本手册,导致了双方工作不协调的状态。我们常常发现,即使手册已升级,用户可能依然用着过时的手册,在过时的指导下使用过时的操作和解决方法,从而造成用户的困扰,甚至损失。

其次带来了检索的不便。因为不同的手册以pdf格式分散放置,所以无法提供统一的全局检索功能,因此用户也不能进行快速和准确的内容查询。如果使用者对产品手册不熟悉,当在查询所需内容时,会花费较多时间在不同的手册间浏览和翻找,造成时间和精力的浪费。

推出Transpedia的目的就是为了解决上述两大问题,实现方便的手册维护和管理功能,提供实时同步的手册查询服务,更好的满足用户的需求,提升用户体验。

Transpedia的简单介绍

Transpedia的访问地址为 https://docs.transwarp.cn/点击阅读原文访问

该网站提供了星环所有的对外产品手册,包括Transwarp安装手册、Transwarp运维手册、Inceptor手册、Hyperbase手册、Stream SQL手册、Midas安装手册、Transwarp安全手册、Discover手册、Waterdrop手册、Inceptor ODBC开发手册、Manager REST API手册以及版本更新说明。

用户可直接通过上述网址进入Transpedia首页,浏览文档列表,访问手册。星环将及时更新维护各手册,保证用户通过最便捷的方式从Transpedia平台获得最新、最全面、最可靠的产品使用手册查询服务。

Transperdia主要提供了两种功能,一个是内容浏览,另一个是关键字检索。下面将对这两大功能分别进行讲解。

内容页面浏览

手册内容浏览是Transpedia的基本功能。除了普通的内容展现,我们还提供了页面索引以加快内容定位。使用时,用户首先需访问Transpedia网址,进入Transpedia首页面,如下图所示。该页面依次罗列了所有产品手册,直接点击封面可查看指定手册内容。

进入相应文档后,首先看到的是主目录页。该页面列举了手册中各章节标题,点击标题即可以进入章节正文。

在正文页,用户可以看到页面左侧显示的目录栏,它提供了手册所有章节详细的目录链接,使用户不必通过不断滚动网页,就可直接点击阅览其他章节,方便快捷。

  • 示例

下面以《Inceptor手册》为例,演示通过Transpedia查阅手册的方法。

(1)点击打开《Inceptor手册》封面,进入主目录页,如下图所示:

(2)由上图可知《Inceptor手册》内容共有十章,点击“3.Inceptor SQL手册”进入第三章——“Inceptor SQL手册”,内容如下所示:

3)从上图可见,“3. Inceptor SQL手册”页面左侧目录栏包含了《Inceptor SQL手册》所有小节的链接,用户可直接点击,跳转至指定小节。

关键字检索

另外Transpedia还提供了关键字查询服务,帮助用户快速、准确查找定位检索内容。

点击Transpedia页面右上角的查询按钮 ,即可进入查询页面:

用户可以在检索内容输入栏中输入多个关键字,用逗号或空格隔开。它还提供了OR、AND、EXACT三个查询选项,显示于右侧,用于表达三种关键字查询关系:OR表示查询至少包含一个关键字的内容页面;AND表示查询包含全部关键字的内容页面;EXACT表示精确查询,以关键字按序组合的短语或者语句为查询对象返回结果。

用户还可以根据需要通过勾选待查询的目标手册,自主选择关键字的查询范围。完成查询设置后,点击页面右上角蓝色查询按钮,就可以获得符合筛选条件的内容页面列表,使用者可浏览并直接点击,进入所需章节页面查看。

由于检索栏始终定位在网页顶部,因此用户即使在章节内部浏览内容,也可以随时进行检索设置,保证了使用方便性。

  • 示例 

下面我们将给出一个关键字检索的使用示例。

假如我们要在《Transwarp运维手册》和《Inceptor手册》中查找同时包含“transwarp”和“inceptor”两个关键字的页面,应该按照如下步骤实现。

(1)首先点击查询按钮,进入查询页面,输入transwarp和inceptor两个关键字,用空格或逗号隔开,并只勾选《Transwarp运维手册》和《Inceptor手册》,选择AND选项,如下图所示,完成相应查询设置

 

(2)点击页面右上角蓝色查询按钮 ,开始查询,得到如下图所示的结果列表:

可以看到,检索结果罗列的每个章节页面都包含“transwarp”和“inceptor”两个关键字,并由黄色标注。

(3)点击第一个列表,进入Transwarp运维手册的“1.1transwarp Data Hub介绍”页面,如下图所示:

进入正文页后,关键字“transwarp”和“inceptor”仍处于被黄色标注的状态,有助于增强用户对内容查看的快速与方便性。

总结

Transpedia是将星环产品文档整合在一起并进行实时更新的一款产品。有了它,用户无需下载,只要通过浏览器,就可以随时在线查看最新产品手册,避免了传统手册发布方式造成的不便,节省了时间和精力的开销。

统观本文提到的功能,Transpedia的优点可以总结为以下三个:

  1. Transpedia通过对各手册的整合,方便了星环文档人员对手册的维护,简化了手册发布版本的管理。

  2. 用户可随时访问Transpedia,在线浏览和阅读产品最新手册,避免消息滞后带来的不便和业务处理的耽搁。

  3. 用户可使用Transpedia提供的关键字查询服务,在全范围文档中快速、准确查找检索所需内容。

这三种优点帮助星环基本消除了以往手册发布流程中存在的问题,提升了手册阅览和查询的效率。

以上是对Transpedia网站和使用指南的介绍,希望读者通过本文能快速理解和使用Transpedia,使其成为手册阅览的好帮手,提高TDH各产品的使用体验。

Transpedia地址:https://docs.transwarp.cn/.

 

对此篇文章如有任何问题,欢迎以邮件形式联系我们:bigdataopenlab@transwarp.io