新的和改进的工人文档

2020-08-20 00:01:52

我很高兴宣布工人文档的几个更新,这些更新将允许您充分利用我们的工人平台。我们整合了您对Docs用户体验和设计的反馈。我们重新组织并重新格式化了我们所有的内容。我们升级了文档引擎以添加新的UI组件。文档现在可以直观地导航,内容现在也很容易阅读。

您可以在这里找到我们新的和改进的文档站点,并可以在我们的repo上找到文档引擎。

我们希望这能为您创造更好的开发体验,并使文档更容易为初学者所接受。我们计划使用我们对工人文档的工作和改进来修改其他Cloudflare产品的文档。

内容组织:我们将站点内容重新组织为四个类别,以便于您阅读和查找内容:教程、操作指南、技术参考和学习。新的内容结构在很大程度上受到了Divio文档系统的启发。

教程部分将构建关于工人的特定项目(例如,教初学者如何烹饪)的逐步指南组合在一起。操作指南是示例的集合,帮助开发人员理解和实现Worker平台的特定功能(例如,食谱中的食谱)。在新的文档中,操作指南部分分为示例和入门页面。您可以将示例视为代码片段,将初学者视为完全完成且可克隆的项目。技术参考是针对工人的每个技术组件的描述性细目(例如,参考百科全书文章)。在新的文档中,我们决定将参考部分分为三组,分别用于平台、运行时API和Wrangler文档,以使内容更容易找到。学习部分建立了对关于工人平台的特定主题或概念的理解(例如,一篇关于烹饪社会史的文章)。

关键的见解是,通过以这种方式拆分内容,四种类型的文档中的每一种都只有一项工作,因此它可以真正地解决问题。此外,它使您更容易找到您正在寻找的东西。

改进了格式:我们在内容中增加了更多的结构和细节。这里有几个例子。首先,像Request类这样的参考页面现在提供了更多上下文,其中有一个背景部分解释了如何使用该类的用例和提示。我们还在右侧边栏中添加了一个目录,以使浏览页面变得更加容易。

我们还清理了内容的格式,如类细分。过去,这是通过大块头的文本段落来实现的。在新的文档中,列出了每个变量和参数,并使用大量空格进行说明,以提高可读性

类似地,我们改进了过去是表格的命令细分的格式。现在,对于类细分,使用相同的基于列表的格式很容易阅读。

重新设计的页面:通过文档引擎重写,我们添加了新的UI组件并创建了新的页面设计。例如,在示例页面中,我们添加了标记,以便您可以按类别排序。此外,整个布局也得到了改进,使每个示例都更易于阅读和理解。

另一个很好的例子是教程页面。我们更新了页面以显示每个教程的难度和长度。这应该会使教程和学习如何在Worker上开发对初学者来说更容易理解。我们还添加了新的教程,例如如何使用Lerna管理多个工人项目。

精确搜索:我们更新了Algolia文档搜索的设计。文本现在更容易阅读,结果的优先顺序也比以前更好。

暗模式:您现在可以根据自己的喜好定制文档,并在亮模式和暗模式之间切换。我们设计这两个主题非常容易阅读和视觉上的吸引力。

我希望这次更新能让您有更好的使用文档的体验。我们有更多的更新计划,并且一直在寻求改进。如果您有任何反馈,请在此提交问题。

CloudFlare工人文档