帮助中心:可重用的内容
计划我们正在为我们的应用程序提供每个页面的帮助内容,但我们也希望能够提供基于工作流的文档。为此,我很惊讶帮助中心不允许任何可重用的内容。
我的请求类似于wiki中的“include”或“transclude”语法——Atlassian有一个很好的文档页面说明了我的请求:https://confluence.atlassian.com/display/DOC/Excerpt+Macro同样的功能在FrameMaker中作为“insets”可用,它们对于处理高度结构化的文档非常重要。
在单源环境中,将Page a中的一段文本标记为可重用,并设置一个URL,该URL可以调用已标记为可重用的部分。当您在Page B中添加对该内容的引用时,它将显示(通常)包装在Page B内容中的Page a内容。
例如,我有一个帮助中心的主题,关于如果你丢失了你的卡该怎么做。在其他一些情况下,您会做与丢失卡片完全相同的事情,因此我想将该过程标记为可重用,并将其包含在其他情况的帮助中心主题中。这样,例如,如果流程中包含的“冻结我的卡”帮助电话号码发生变化,我只需要在一个地方更新它,而不必在整个帮助中心寻找对该号码的任何引用。
-
+ 1
-
基本DITA功能+1。
我们的软件使用偶尔会改变的特定术语和短语。当我们的产品管理部门声明我们现在将“Resume Parser”称为“Resume Processor”时,如果可以在一个地方编辑标记值,以影响术语“Resume Parser”的259个实例,那就太好了。
谢谢!
-
+ 1
-
+ 1
-
+1!
-
+ 1
-
大家好——
请确保您使用了原始帖子上的投票按钮添加了您的+1。还有谁能举例说明如何使用这个功能或者为什么需要它?
-
我们如何使用内容重用:
- 使用文本字符串在文章中插入URL.例如,假设我们有五篇文章链接到https://some-website.com/common-resource.
通过内容重用,URL可以被引用,比如短代码:
(common-resource-URL)
然后,我们将短代码放入所有五篇文章中。Guide解析短代码,然后在所有五篇文章中显示URL。 - 使用文本字符串代替定义.假设我们有五篇文章,其中都包含一个简短的段落来描述我们的产品Foobar。通过内容重用,我们将短代码[foobar-definition]放入文章主体中。指南将在每个文章主体中显示相同的定义。
- 使用文本字符串代替有序列表.假设我们有5篇文章都包含以下步骤:
1.更新foo。
2.选择该栏。
3.保存更改。
通过内容重用,我们可以使用简短代码[foo-the-bar-procedure]引用这个有序列表。因此,每当我们在文章中放入短代码时,有序列表就会自动生成。
为什么呢?
如果没有内容重用,只要URL、定义或过程发生变化,我们就必须手动更新这五篇文章。文章跨越多个类别或部分,我们希望在Zendesk上进行搜索,可以找到需要更新某些内容的所有地方。亚博
使用内容重用,您所要做的就是更新一段内容,然后将更改部署到多个文章中。看到https://en.wikipedia.org/wiki/Single_source_of_truth。
- 使用文本字符串在文章中插入URL.例如,假设我们有五篇文章链接到https://some-website.com/common-resource.
-
如果能够在ZD内实现这一点就太好了,但是作为第二种选择,有没有人知道可以用来创建/管理KB内容,然后使用ZD API将内容推送到Guide的内容管理工具?
-
我最近一直在问同样的问题,并了解到以下信息
https://mindtouch.com/亚博电脑端resources/announcing-mindtouch-touchpoint亚博-for-zendesk
希望这能帮到你,
安
-
我目前正在尝试一个基于云的CCMS,它集成了ZenDesk Guide,对于这个话题的一些人来说,这可能是一个可行的解决方案。亚博
- 使用基于主题的创作
- 支持主题重用
- 基于DocBook框架(但也集成了Oxygen XML作者/编辑器,适合喜欢DITA的人使用)
我已经在我们的ZD沙盒上发布了几篇文章,它非常简单,尽管我必须对我们的ZD主题和Paligo CSS文件进行一些编辑,以维护我们文章中想要的样式。
对于没有时间/资源学习Python和手动利用ZD API的团队来说,这似乎是一个很好的解决方案。亚博电脑端Paligo为您处理所有这些问题,并将文档团队解放出来,让他们专注于内容和策略。我现在正在给自己上结构化创作的速成班(一个很大的话题,真的),但这次经历真的让我大开眼界。
-
你好,
我想知道您是否开发了一种将DITA内容和Oxygen模板设计集成到Zendesk中的方法。亚博上面,您声明使用DITA作者(Oxygen?)创建内容,然后转换为html,然后推送到知识库。亚博官方app这似乎是一种相当低效的创建内容的方式。
你是否在寻找一种方法,我们可以使用氧气来创造内容,而不必转换然后推送?
另外,什么时候才能在节中创建子节,以及其他更清晰地显示KB主题的方法?我没有看到任何关于何时可以,如果有的话,可用。我希望能够细分部分,并有细分可折叠,因为我可以使用氧气时。
-
嗨,珍。
今年晚些时候,暂定计划开发更多的类别和部分的灵活性。时间表可能会改变,不能保证,但我们确实在路线图上有。
-
基本DITA功能+1。
我对你的也很感兴趣https://paligo.net/经验莎拉Holdgrafer已经好几个星期了,最近怎么样?
是否有意在未来18个月内将DITA纳入指南路线图?
-
嘿,丽贝卡——
我会和产品经理核实一下,看看他们是否在讨论这个问题。
-
嘿,丽贝卡,
Paligo的试用非常有趣,也是一次很棒的学习经历(在过去的一个半月里,我基本上上了结构化和基于主题的写作速成班,这完全改变了我对公司做事方式的看法——向Write The Docs社区大声说出来,他们和我聊天,给我发了大量很棒的内容)。
和我一起工作的代表(Steve)以及回答我问题的支持人员都非常积极,而且对如何有效地管理ZenDesk集成也非常了解。亚博很明显,他们对自己的平台及其优势充满热情。
我们决定为我的团队获得许可证,我们还将Paligo培训师带到这里,培训我的团队高级功能(如版本控制和本地化)、最佳实践和策略。由于我们所有的内容目前是非结构化的,培训师也将工作我们的内容直接与我们一起,以确保我们可以击中地面运行。
该平台本身非常直观,发布工作流程也是如此。我真的很期待制定我们的新战略,并且已经有了大量的想法,这些想法远远超出了我们的知识库,如果没有这样一个平台,在后勤上就会非常困难。亚博官方app
我已经向我们的市场营销部门展示了我的一些想法,关于我们如何将它用于各种类型的用户文档(特别是入职),所以他们也很感兴趣,但现在没有足够的带宽来处理它。意思是,我基本上是公司的小白鼠:-)我想几个月后,我可以带着一些可交付成果去找他们,让他们大吃一惊,然后对他们进行培训。我这么兴奋是不是很奇怪?: -)
-
嘿,所有的,
总的来说,是的,我们正在寻找可重用的内容,并且有一些不同的用例,我将在下面概述并给出一些见解,说明它可能适合我们的计划
- 在多个部分或帮助中心发布一篇文章——我也在其他一些地方说过,但这是更大工作流程的一部分,我们计划在2019年第一季度推出该功能的EAP
- 文章模板——这是关于能够从一个基本模板创建一篇文章,作者可以填写细节。我们目前使用知识捕获应用程序在这方面有一些功能。我们正在进行更深入的研究,以了解更多关于他的信息,并充实它的工作原理。目前还没有功能可用的时间表
- 在多篇文章中重用一篇文章的部分内容——我们目前对动态内容的宏和主题提供了一些支持。我们正在寻找方法将其升级为真正可重复使用的摘录,就像Atlassian一样。目前还没有功能可用的时间表。
- DITA支持——正如本主题中提到的一些地方,有许多基于DITA的工具,如Oxygen和Paligo。这些都是用于文档创作的伟大而复杂的工具。其中一些已经使用我们的API与Zendesk集成,或者可以通过API扩展与Zendesk集成。亚博我们还没有决定任何进一步调查的计划。
还有@Sarah,看到人们对这些东西着迷真是太棒了:)
-
@Ryan,谢谢——文章文本中的动态内容将是巨大的!
-
同意Johathan关于动态内容庞大的评论。这将使更改产品或公司名称变得非常容易。
-
@nicole @ryan -有没有更新时间表让ZD使用可重用的内容?
-
嗨,瑞安,
动态内容有进展吗?能够重复使用内容将是一个巨大的优势。
-
大家好!
我们正在围绕各种客户需求进行研究,这些需求与Guide Content中的用户变量(有时称为占位符)有关。具体来说,我们希望更多地了解您和您的组织将如何使用以下功能:常用名称、上下文信息、占位符和格式化片段、内联图像等。
如果你对这项研究感兴趣并想分享你的观点,请填一下这张表.
指导团队。
-
@……
有更新吗?
-
嗨,亚历杭德罗
我知道产品团队正在继续开发一些功能,预计在不久的将来会推出EAP。当有实质性的东西要分享时,他们会在这里提供更新。
-
@……
谢谢你的回复。
你能把这句话作为官方回应吗?
有时候,很难在一个帖子的所有评论中找到Zendesk的回应。亚博
-
当产品经理发表评论时,我们会将其标记为正式回复。
-
有什么进展吗?对我来说,理想的情况是使用Git存储库作为唯一的事实来源。标准的内容管理系统(CMS),如Hugo、Jekyll、Gatsby等,已经包含了这个特性。
如果我们可以将由我们选择的CMS处理的页面从Git存储库导入到Zendesk文章中,那就再好不过了。亚博
在过去的一份工作中,我所在的组织不得不放弃Zendesk,因为它缺乏这个功能。亚博我想知道我是否应该为我现在工作的组织推荐同样的东西。
请登录留下评论。
29日评论