Ragic 博客
企业电子化的专家 Ragic 教你如何利用各种软件、
云服务让公司快速升级!
加入 Ragic 企业电子化的行列!
云工作术
各类应用演示
案例故事
逃离恶梦
关于 Ragic
Facebook X YouTube
云数据库
博客
关于Ragic
云工作术
各类应用演示
案例故事
逃离恶梦
关于 Ragic

Ragic 内部小故事:谁来更新“使用说明”?一张表单轻松分派文档修订工作!

作者:Jaykee Chou

你看过我们的教学文档吗?对于任何工具来说,配有一套产品文档,可以让客户在遇到问题时有一个方便的管道,自行搜索、调试,从供应商、官方客服的角度来说,说明时搭配文档也可以减去许多沟通成本。

但你知道吗?像 Ragic 这类的 SaaS 工具,经常每周更新调整功能,教学文档的信息需要跟着调整、更新的频率,也比一般产品高得多,如此才能确保让用户能接收到最新信息。

而且,我们的文档复杂度也较高——除了根据各种用途、受众进行归类,也需要区分成各个语系。因此,有个统一的“指挥中心”,能在一个地方清楚地纪录目前有哪些内容等待修订、要修改哪一个归类、语言的文档,并直接在表单内指派修订的负责人的话,团队的运作也能更加清晰、有效率。

这个需求跟我们之前介绍过的功能开发管理表单的背景非常相似,都是因为在线协作时,工作量较大、较杂,而需要一个地方整理工作项目,提供说明并分派负责人,而且在我们团队扩张时,也要能很方便地调整、扩大表单结构的需求。这个时候,Ragic 表单就是一个非常好用、方便单击需调整的工具,我们也借助之前的经验,设计了一张名为“Documents to add”的表单,用以纪录信息、指派修订工作,长得就像这样:

你可能会好奇:每个语言下面都只有一个放文档的字段,如果一次修订需要调整很多种文档该怎么办呢?其实这张表单里有很多字段都是“单击需显示”的,只显示需要的字段,更可以提升我们阅读与工作的效率!继续看下去,了解这张表单怎么担下“指挥中心”的重责大任,确保信息足够清晰、提升大家工作与阅读的方便性吧!

输入概要、确认负责人,简单操作登记工作项目

在 Ragic,不管是因为有功能更新、收到客户反应甚至是大家觉得文档有一些地方“越看越不顺眼”等等,而需要新增段落、新的文档或是对现有文档进行大幅度改写时,都可以在简单确认过后,新增一笔数据、纪录修订文档的需求。

在新增修订纪录时,只要注意表单上部的描述够清晰易懂、再选择需要修订的文档,就可以直接保存数据,登记需要修订的内容给大家啰!

在 Ragic,可以用 bbcode 句法或简单的网址超链接,轻松附上参阅信息,这张表单就用了这个超级简单的方法。

以新功能的文档修订需求来说,可以在“Issue URL”字段中填入对应的功能开发纪录,而如果需要参阅订户使用情境,就可以在“Related Tickets”字段简单放上对应的客服表单网址。

但是登记完需求之后,要怎么指派负责人,又要怎么确认谁来进行编辑与修订的工作呢?这个时候,就要用到表单下部的“Status”区块了。我们在这之中创建了选择用户字段,并设置指派功能,这样一来,负责人就能在被指派的当下,以及后续数据有修改时自动收到通知。负责人修订完文档之后,只要将文档网址贴在表单上让大家检查后,就完成修订工作了。

害怕表单太杂乱?设置条件、根据需求显示字段!

你曾经被太过复杂的表单搞得眼花撩乱吗?因为 Ragic 的文档有多种归类,但大多数时候,我们都只要修订一到两种文档,而负责人修改完文档之后需要将网址填进相应的字段里,如果每一笔数据都一次把所有文档的字段列出来,其实负责人常会认不出来自己需要修订哪些文档,不够清晰、直觉:

为了解决这样的问题,我们使用了条件式格式,让表单上的字段可以依照“Add to”字段的选项,自动显示或隐藏。

这样一来,表单就可以尽可能地保持简洁,确保负责人在看到数据的当下,就能直观地确定自己需要修订哪些文档了:

团队扩张,支持新语系?弹性设计超方便!

就像我们在产品路线图提到的,Ragic 会逐渐支持更多语系,让各国的客户都有机会用母语使用 Ragic。随着我们团队的扩张,文档也从最早的中、英两种语言,慢慢扩大到现在还有日文、西文和法文的版本,在这个过程中,我们是怎么调整表单、新增语系的呢?

其实只要进入设计模式,简单地做几个拷贝、贴上,再稍微修改一下字段名称,表单就能马上“无痛升级”,配合我们的工作流程了!

同场加映:那么,文档是在哪里修订的呢?

看到这里,不知道你会不会很好奇,前面都只讲到了我们“分派”修订工作的方式,那么实际上在运行修订工作时,我们又是用什么方式、工具来修订文档的呢?

其实我们用来管理、编修各语言文档的工具,也是 Ragic 本身!在我们的数据库内,各个语系、各种文档都分成了一张一张的表单:

而各个表单里的数据,其实就是每一篇在线文档的“来源”,我们藉由 RESTful HTTP API 设置集成,并单击照网页需要呈现的内容设计表单,让 Ragic 表单变成文档的后台!只要我们在 Ragic 修改相应文档的数据,设计手册的内容就会一起改变。

举例来说,我们的设计手册有一篇“Javascript 工作发动机”的教学,看起来就像这样:

而这篇文章在 Ragic 表单里对应的数据看起来是这样:

这样一来,修订文档的负责人就能像平常使用 Ragic 一样,简单地修改字段内容,只需要掌握一些 HTML 句法(我们也特别建了一个表单保存常用的句法),就能完成文档编修啰!

归类: 关于 Ragic, 我们的故事

博客背后使用 Ragic! : 最强大的 No Code 企业电子化工具
把数据放在Excel上不只是拖累团队的行政效率,他也很容易出错并且无法进行任何内控。
当您的团队成长时,使用Excel管理数据就会越来越痛苦。
创建你们的第一个云数据库!

马上登记
免费试用 Ragic!

用 Google 帐号登记

立即科技 Ragic, Inc.
02-7728-8692
info@ragic.com
台北市中正区南昌路二段81号9楼