打动客户:10个惊人的产品文档实例

Avatar of Author
Ciaran Sweet
on October 25, 2021 · · filed under Product Documentation Best Practices Technical Writing API Documentation Product Documentation Tutorials
查看Docsie团队最喜欢的文档范例,以及如何在你的知识门户中复制这些范例

文档是产品开发过程中的一个组成部分。随着产品从概念验证走向现实,解释性的文档对于教育客户如何使用你的产品至关重要。

当客户选择一个产品时,首先需要知道的是什么?它是用来做什么的,它能做什么,以及我怎么做?让我们以Docsie为例!

Docsie是一个产品文档平台。它允许用户在一个在线知识门户中创建、编辑、注释和发布文档。这就像登录,创建一个新的Docsie书,然后输入你的第一篇内容一样简单

诚然,我们保持了它的简单性。然而,对于产品文档来说,复杂的特性和功能需要更全面的解释,以使概念深入人心。

在这篇文章中,我们将探讨Docsie团队最喜欢的10个出色的产品文档的例子。更好的是?我们还将向你展示如何制作你自己的惊人的产品文档(从我们的惊人的例子中得到启发!)。

让我们开始行动吧!🤿

10个惊人的产品文档例子

下面,你将看到Docsie团队选择的10个惊人的产品文档例子。我们将探讨如何复制特性和功能,并在Docsie中创建类似的属于你自己的惊人的文档

1 - Docker

Docker是一个容器虚拟化平台,能够在微小的、模块化的、单独隔离的IT环境中进行软件托管。这个概念通过在容器之间分割和共享操作系统资源,使多个不同的服务能够被托管在一个主机操作系统上。

Docker文档

Docker文档门户主页](https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/oywtjgyzfpsynkqslptj "Docker文档门户主页")

Docker有一个格式清晰的产品文档门户,并介绍了下载、安装和运行Docker容器所需的所有基本信息。它还分享了多语言的产品文档、API参考文档,以及底部的常见问题(FAQ)部分。对于视觉学习者,右下方还有一个视频部分。

为了创建一个入门部分,让我们以Docsie为例。要开始使用Docsie,你必须创建一个账户,确认你的电子邮件地址,加载Docsie工作区仪表板,创建一个新的书架,创建一个新的书--这就是基本的工作了为每个部分创建一个标题框架,写上说明,添加图片和超链接,最后你将得到一个类似于下面的结构

最重要的是什么?Docsie会自动为你完成这些工作!

Docker文档中的标题结构示例

查看Docsie是如何做到这一点的,请阅读Docsie快速入门指南!

2 - Stripe

Stripe是一个国际支付处理平台,其技术功能可以通过Stripe命令行界面(CLI)实现自定义集成和支付参数。它的使命是通过建立简化电子商务的虚拟经济基础设施来提高互联网的GDP。

阅读更多关于Stripe CLI的信息

带有代码高亮示例的Stripe CLI文档页

这个Stripe页面被称为技术产品文档。它探讨了如何使用CLI来创建Docker容器(又见面了!)并与Stripe通信,只使用终端命令。在该页面上,您将看到一个目录,带有复制粘贴功能的代码块,以及文本内的超链接。

Docsie有代码块,所以让我们来探讨如何使用它们

查看Docsie中的这个代码块例子

复制这段代码,准备按照我们的例子 - console.log('Hello World');

在Docsie编辑器中打开一本Docsie书。下面的GIF显示了如何在工具栏中找到代码块选项,并包含一个打印 "Hello World!"的JavaScript例子。

显示如何向Docsie Books添加代码块的GIF动画

在你的Docsie门户网站中,代码高亮显示是为了提高技术读者的清晰度。用户甚至可以用方便的剪贴板图标复制代码!

Live Docsie Portal rendering for code blocks example

查看如何在Docsie中应用代码高亮插件!

3 - 苹果

无处不在的苹果!不,不是可食用的那种!

苹果公司为其流行的iPhone系列智能手机提供一些优秀的产品文档。在我们的苹果产品文档的例子中,我们有一个版本选择器,目录,文本和标题,以及最后的线上图片。

苹果iPhone文档页

让我们来探索Docsie中的版本控制!

阅读我们关于在Docsie中管理版本的指南!

当阅读Docsie知识门户中的文档时,读者可以使用版本选择器插件来选择一个版本。

Docsie门户网站的版本选择器

这使得读者可以查看历史产品文档--你知道的,为那些还没有更新的后面的慢速戳!

要在Docsie中创建一个新的版本,请使用Docsie编辑器中的版本管理标签。

Docsie Editor中的版本选择菜单

从这里,点击添加版本+ 。

Docsie Editor中的添加版本按钮

接下来,在点击添加版本按钮之前,选择一个版本号和版本名称。就这么简单!用任何功能变化来更新新的版本文件,让你的客户找到最新(或较晚)的信息

在Docsie编辑器中添加版本上下文选项菜单

4 - 解析

Parse是一个优秀的全栈软件平台,为应用程序后端提供开源框架。简单地说,它提供预制的代码资源,开发人员在与任何开发项目整合时都可以信赖。

在Parse的文档门户中,有一个很好的文档范例,即兼容性表的形式。这监测了不同架构(如Node.js和MongoDB)与Parse平台的兼容性。

Parse网站上的示例版本兼容性表

让我们在Docsie中制作这个!

我们可以用Docsie中的表块制作一个类似于Parse例子的四列表。

Docsie表块图标,四列选项突出显示

选择表块图标,然后选择四列选项。

在你打字时,使用回车键沿着各列移动。使用键盘上的Ctrl + B,使文字变粗。最后,使用符号选项添加表情符号。

在Docsie Editor中复制的四列表格

Docsie Editor中的符号选择菜单

Docsie Editor中符号上下文菜单的表情符号和符号选择表

了解Docsie Editor的工具条。

这是编写API文档和技术软件文档的一种简单方法。你可以通过添加到Node.js网站的超链接,或相关用户指南的内部链接,更进一步。用Docsie交付你的下一个API兼容表吧!

5 - Flutter

Flutter是一个由谷歌创建的UI工具包,旨在推动移动、网络、桌面和嵌入式设备的用户界面设计的一致性。它通过一个在线代码编辑器促进了快速的UI设计和开发,而基于容器的分层架构允许完全定制。

Flutter主办了一系列视频,供用户观看和了解该平台。由于该平台是由谷歌公司制造的,因此YouTube是我们的例子的合理选择!

Flutter YouTube视频示例页面

您可以在Docsie中使用视频嵌入块来模仿这种设计!

如何使用Docsie编辑器工具条将视频嵌入块添加到Docsie图书中

只需在你的Docsie Book中点击,选择视频嵌入图标,然后将YouTube的URL复制到文本区域。你也可以对Dailymotion、Vimeo和其他一些视频托管网站进行同样的操作。

我们有一个GIF图来展示这个过程,这样你就可以把自己的视频添加到Docsie中去了--试一试吧!

了解如何使用Docsie编辑器工具条。

6 - Ionic框架

Ionic框架是一个开源的UI工具包,用于使用HTML、CSS、JavaScript和其他网络技术构建高性能的桌面和移动应用程序。

它与Angular、React和Vue等流行框架集成,具有各种UI组件、本地设备功能和主题支持。

Ionic在其网站中嵌入了一个很好的手机例子。让我们在我们的Docsie Book中使用iFrame嵌入来添加一个类似的例子吧!

首先,复制下面的代码:

<iframe loading="lazy" importance="low" src="https://ionic-docs-demo.herokuapp.com/?ionic:mode=ios"></iframe>

接下来,点击Docsie编辑器中的代码嵌入块。将iFrame嵌入代码粘贴在这里,然后点击保存继续。我们有一个GIF说明这个过程,如下。

如何使用Docsie Editor工具栏在Docsie Books中嵌入iFrame集成

Docsie Portal中的实时iFrame示例

查看我们在Docsie中使用iFrame的官方集成列表!

7 - DigitalOcean

DigitalOcean是一个云计算服务平台,使客户可以托管服务器、虚拟机、数据库等。它为可扩展的容器应用提供专门的Kubernetes服务,并为虚拟主机、移动应用、大数据湖和VPN服务提供管理解决方案。

DigitalOcean在其文档上提供反馈功能,以收集用户反馈并迭代内容。让我们来探讨如何在Docsie中做到这一点

DigitalOcean Docs page with feedback collection functionality example

Vocally是Docsie中收集反馈的同等功能。它允许用户留下星级评价、文字反馈,甚至可以录制视频--很贴心!

如何在Docsie工作区主菜单中访问Docsie Vocally](https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/jobysqxbnhuglnpjbkoe "如何在Docsie工作区主菜单中访问Docsie Vocally" )

在这里,你可以访问任何提交的Docsie Vocally反馈。用户可以选择1-5星的评价,以及简短的文字说明。有些用户可能愿意留下屏幕录像,以帮助你准确地找出问题所在!

Docsie Vocally仪表盘中用户反馈和视频回放的实时示例

每个Docsie客户都可以访问Vocally,它在揭示你的文档的优势和劣势方面是非常宝贵的。你不可能第一次就做对,但当你的作者使用Docsie Vocally时,你可以在下一次迭代中做得更对!

8 - Slack

Slack可以说已经成为商业世界的Whatsapp。这个流行的商业即时通讯(IM)平台提供语音和视频通话、图片和GIF共享、评论回复树等功能,以组织和简化商业通信。

Slack在其文档门户中提供工具提示,以突出重要信息,并呼出相关功能。让我们在Docsie中复制这一点!

Slack文档门户中的呼出块示例

我们可以在Docsie中使用引号块制作类似上述的工具提示。

了解如何使用各种Docsie编辑器按钮。

只需导航到Docsie编辑器的工具栏,选择报价块图标。在这里,你可以选择信息、警告或问题块类型。我们在下面的GIF动画中对此进行说明。

如何使用Docsie Editor工具栏在Docsie Books中添加呼出或引用块](https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/cientdcamlnfozadvsgw "如何使用Docsie Editor工具栏在Docsie Books中添加呼出或引用块" )

以下是在实时的Docsie门户中使用信息、警告和问题报价块的一些变化。你还可以使用问题和警告块来创建问答式的语句--在你的下一本Docsie书中使用引语块,发挥你的创造力吧!

Docsie Portal中所有三种呼出或引用块类型的现场示例

9 - Rust

Rust是一种以速度为目的的编程语言。它可以防止segfaults并保证处理器线程安全。Rust可以用来创建REST-API框架,与PostgreSQL等数据库解决方案进行通信等等。

Rust标准库包含行内代码片段,其作用是简化API文档的浏览。让我们在Docsie中匹配它吧!

Rust门户中带有标记代码的文档示例

内联代码片段包括Vec<T>Option<T>。我们可以在Docsie中使用markup按钮来完成。

Docsie编辑器工具栏的标记切换图标

要将文本标记为代码,只需点击和拖动以突出文本,然后点击标记按钮。我们有一个GIF图来说明这个过程,如下所示。

GIF动画显示如何在Docsie Books中使用Docsie Editor工具栏对文本进行标记

标记文本也包含超链接。这个链接应该重定向到一个术语表,解释代码片段的作用。

上一堂关于如何在Docsie中创建超链接的速成课。

10 - Yoast

Yoast是一个搜索引擎优化(SEO)平台,旨在帮助企业优化其WordPress网站,并提高对SEO最佳实践的认识。Yoast SEO插件可以优化网站,使其在谷歌搜索引擎结果页(SERPS)上有更好的表现,以推动客户参与。

Yoast在其文档门户中提供了使用列表头的一步步指南。我们可以用Docsie中的列表头来复制这一点

Yoast文档门户中的步骤标题示例

要在Docsie中做到这一点,首先创建一个书,并打开Docsie编辑器。

接下来,点击文本字段,在Docsie编辑器的工具栏中选择列表头选项。我们在下面的GIF中说明了这个过程。

GIF动画显示如何使用Docsie编辑器工具栏为Docsie书籍添加阶梯标题

列表头是HTML规范的一部分。在Docsie中,列表标题非常好,因为它允许你在文档中创建直接链接。这意味着当用户点击一个链接时,他们会被直接带到列表头(而不是滚动或滑动!)。

如何使用Docsie编辑器工具条在Docsie书籍中添加视频嵌入块](https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/lradwltxuqolxfmzxxwr "如何使用Docsie编辑器工具条在Docsie书籍中添加视频嵌入块")

了解更多关于Docsie Editor的功能。

利用这些Docsie功能来发挥你的优势!🏆

这10个文档实例显示了用户指南的好处。下次你创建用户指南时,请使用这些Docsie的技巧和窍门来发挥你的优势吧我们选择的例子很好,但我们知道你的例子会更精彩📐👌

Docsie是一个端到端的文档管理平台,企业用它来创建基于网络的FAQ、产品文档、用户指南、帮助文档和用户手册。该平台具有以客户为中心的协作、广泛的嵌入、定制的翻译和强大的发布功能,让您触手可及。

今天就开始上岗,用Docsie提供令人愉快的数字文档吧!


Subscribe to the newsletter

Stay up to date with our latest news and products