整合11个强大的工具,实现最佳的产品文档。

Avatar of Author
Ciaran Sweet
on July 28, 2021 · · filed under Product Documentation Documentation Portals Best Practices Technical Writing Product Documentation Tutorials

产品团队需要创造产品文档的伟大,以提供一流的客户体验。文档本身就像商业产品的百科全书;准确性和可读性越高,你的客户就越容易理解你的产品并提取价值。

Docsie是一个强大的文档管理解决方案,直接针对这些需求。编写人员只需轻敲几下键盘和一些简单的点击,就可以创建产品文档,编辑文档,并将文档发布到网上。其结果是集中的、可访问的产品文档,具有组织、全球搜索、反馈整理和富媒体支持。

我们不想承认,但是......Docsie不能做所有的事情......然而,有一些优秀的工具,Docsie用户可以整合到他们的工作流程中。这些工具可以帮助我们创建产品文档,我们邀请你用我们的永久免费启动计划在Docsie中尝试一下这些工具!

让我们开始写作吧!

用11个强大的工具提升你的Docsie体验

1.专业写作助手

首先,我们有Pro Writing Aid。这是一个语法、拼写和句子结构的工具,帮助作者创建产品文档。

如果你(哎呀!)在写作时不太可能记住"you're"与"your",这个工具可以捕捉到错误,并在即时提供上下文建议。

它还可以提供阅读等级(如13级)、句子种类监测(短句后是长句)和被动语态("我将做的工作"vs"工作将由我来做")。

语法、拼写和句子结构比许多人认为的更重要。当客户看到糟糕的语法、拼写错误和段落冗长的句子--这让他们对你的产品失去信心。例如,对于一个针对儿童的产品来说,一个高的阅读等级是适得其反的。被动语态往往会浪费屏幕空间,让读者感觉迂回,而主动语态则短小精悍,直指要害。

在你的Docsie工作流程中加入Pro Writing Aid;改善你的文字,激发你的客户。

2.QuillBot

在内容开发中,转述是一种常见的做法,当你创建产品文档时,这也是真实的。可悲的是,尽管我们很想相信,但我们并不是第一个有这种想法并把笔写在纸上的人!"!

释义就像用不同的词说同样的事情一样简单。QuillBot是一个人工智能软件工具,可以自动为你转述,避免抄袭及其声誉或版权相关的后果。

"如何进行转述? "

只要输入你的句子,点击"Rephrase",右边就会出现一个转述的摘录。很好,是吧?

如果你在互联网上重新利用内容,可以考虑让QuillBot和Docsie一起试试。我们总是推荐原创,QuillBot仅仅是一个能使原创自动化的工具。

3.抢答器

产品文档不只是文字......它需要图像和艺术作品来说明全貌(双关语)。通过提供附有图像的分步说明,用户在遵循用户产品指南时有更大的确定性和信心。

在Windows上,可以使用剪贴工具。对于Linux,可以使用(Shift/Alt)+PrintScreen键盘快捷键进行截图。在macOS上,这可以通过Shift+Command+5来完成。然而,功能是有限的。

我们的软件文档工具清单上的下一个是Snagit。它作为一个多合一的屏幕捕捉工具更进一步。用户可以拍摄整个显示屏的屏幕截图,窗口化的屏幕截图,或者画出一个屏幕截图捕捉区。Snagit还可以捕捉视频和语音记录,例如通过网络摄像头。最好的部分是它的编辑功能,能够在屏幕截图中进行箭头和文字等注释,或者对GIF和视频进行修剪和声音叠加。

简单地说,Snagit是一个为产品文档编写者建立的屏幕截图、视频编辑和通信解决方案。下次你需要为你的Docsie Books提供图片时,可以考虑试试它!

4.Camtasia

来自Snagit的制造商(这是电影预告片吗?)--接下来我们有Camtasia!

Camtasia与Snagit相似,但专注于屏幕录制和视频编辑。用户可以利用带有转场和现代风格的视频模板,并与团队分享模板,以简化视频创作工作流程。免版税的Camtasia资产库在没有版权负担的情况下增加了视觉效果。与Snagit类似,Camtasia支持注释、设备取景(全屏、窗口、绘制区域)和双输入音频录制(包括麦克风和系统声音)。

YouTube上的Camtasia已经是2008年的事情了,但现在开始使用这个工具在Docsie中创建产品文档还不算太晚。给你的文档一些轰轰烈烈的力量吧!

5.Tableau

数据确实让现代世界运转起来!但原始数据对人类来说很难理解!然而,原始数据对人类来说是难以理解的。计算机一直在与原始数据打交道。

Tableau将原始数据转化为美丽的可视化,使所有受众更容易看到和解释模式、趋势和其他数据洞察力。它支持广泛的数据库类型,包括关系型数据库(RDBMS)、非关系型数据库(非RDBMS)和面向对象的数据库(OODBMS)--导致几乎无限的数据可视化潜力。

下面是一个嵌入Docsie Book中的Tableau可视化实例。

自己测试一下这个可视化打开Docsie,创建产品文档(一本书),并选择Docsie编辑器中的嵌入按钮。在这里,粘贴嵌入代码并调整大小以适应你的网页(vizElement.style.width和vizElement.style.height属性)。

嵌入代码(粘贴我!)。

<脚本 src="https://gist.github.com/PhilippeTrounev/ccd08606d97d114a5efb972473e9bb37.js"> 如果你的产品文档使用了统计和数据,那么通过使用Tableau,让用户更容易(也更漂亮)。Docsie支持使用iFrame技术嵌入Tableau,请试一试吧!

6.Draw.io

一个电工从来不会在没有原理图或图表的情况下尝试重新布线和重新安排电线。考虑到这一点,当你提供图表和流程图时,用户可以更快地了解你的产品的内涵和外延。

产品文档的作者可以使用Draw.io来创建流程图和图表。这个软件文档工具提供模板和数以百计的资产,以建立吸引人的、视觉上赏心悦目的图表。例如,对于计算机系统和网络拓扑结构,图表和流程图阐明了系统的层次和数据的流动。为你的产品做同样的事情,阐明基本工作流程和功能

Draw.io是另一个支持iFrame嵌入的工具。创建产品文档,然后直接嵌入到你的Docsie文档中!另外,你也可以用Snagit等工具进行截图,但我们推荐iFrame,因为对图表的编辑会自动传播。

7.Statista

统计数据可以增加文档的权威性。为了包括统计数字,当你下次创建产品文档时,可以试试Statista,以便与竞争对手进行比较,说明市场状况和你的产品如何应对,或者只是增加一些活力

Statista收集了150多个国家170个行业的数据,使其成为统计数据的最佳数字来源之一。所有数据都有同行评议的研究支持,一些数据图表甚至显示预测和预报。

Statista非常棒,因为它支持iFrame嵌入,允许你在Docsie文档中嵌入图形和图表。这些图形和图表会随着时间的推移而更新,确保你的统计数据保持常青状态

创建一个Statista账户,尝试在你的下一本Docsie书中嵌入统计数据吧

8.CodePen.io

软件产品文档与物理产品是不同的。它包括高层次的技术信息、代码片段和依赖性--尤其是在迎合开发人员或工程人员而不是普通用户的时候。

然而,一个JavaScript代码的截图对阅读你的文档的开发者和工程师来说是不可能的。如果代码在图片中,你就不能Ctrl+C!他们需要的是前端的代码沙盘!他们需要的是具有构建、测试和共享功能的前端代码沙盒。

在软件文档工具的海洋中,CodePen.io在执行和说明沙盒代码方面特别出色。

CodePen中的代码在页面上实时执行,准确地向用户展示你的代码的作用。如果你的产品支持自定义代码,这是非常好的,因为你可以分享一个模板化的功能库供用户享用。最后,沙盒环境鼓励实验,激发用户尝试新的东西,充分探索你产品的极限。

嵌入代码(粘贴我!)。

<脚本 src="https://gist.github.com/PhilippeTrounev/4f4b59cdee9840abd42d95012c72655d.js">

尝试在Docsie中嵌入CodePen.io,并利用我们的原生代码高亮功能,帮助你的开发者用户在你的文档中做更多的事情!

9.Doxygen

一个不太知名的工具,但对开发者和软件文档编写者很有帮助。Doxygen(与Docsie无关!)通过扫描代码,识别参数、属性、注释等,自动创建软件文档。

Doxygen的一个扩展是CLion,它使你能够在代码编辑视图中实时查看Doxygen文档输出。

这里有一个探索iTunes COM接口的例子。提供源代码,文档就会自己写出来!

尝试使用Doxygen,并将结果复制到Docsie。然后,你可以使用我们的代码高亮插件和其他格式化选项!

10.Pixlr E

我们已经探讨了如何用Snagit捕捉图像。现在缺少的是一种在桌面和手机上编辑图像的强大方式。Adobe Photoshop很强大,但硬件要求和许可费用限制了它对设计师、艺术家和创意专业人士的使用。

这是一个基于网络的产品文档工具,具有Photoshop的许多功能,但无需在设备上安装。

你可以添加文本,套索和复制像素,模糊,填充颜色(使用十六进制值或RGB色轮),裁剪,刷子,笔,液化,自动修复,添加或删除图层等等编辑过的图片保存在云端,随时可以访问或分享;你所需要的只是一个现代浏览器。

给Pixlr E试一试,同时进行屏幕截图!之后,你可以将导出的图像直接复制和粘贴到Docsie中!

11.JotForm

Docsie已经有一个针对文档的反馈表--Docsie Vocally。不过,这只是针对读者对Docsie书籍的反馈,而不是一般的反馈。

像JotForm这样的产品文档工具允许你创建动态的网络表格,并直接嵌入到Docsie Books中。一个例子是用于知识库,在每篇文章下面,你可以包括一个IT服务票据表格。

与ZenDesk的整合意味着表单的回复可以自动加载到IT服务台的票务软件中

试着将JotForms添加到您的Docsie Books中吧反馈表对于追求卓越的文档是非常有价值的;你无法修复你不知道的东西

今天就试试Docsie中的这些工具吧!

上面列出的每一个产品文档工具都与Docsie兼容!我们强烈建议你在Docsie中试用这些工具,以最大限度地提高你的效率和生产力!

开始精心制作文档,帮助你的客户做更多的事情。注册我们的创业计划(永远免费e!),用Docsie提供满意的文档吧


Subscribe to the newsletter

Stay up to date with our latest news and products