跳到主要内容

Deno 文档的演变

文档是使用工具或服务的关键体验部分。作为开发者,我们经常依赖文档来帮助我们发现工具的功能或教我们如何使用其特性,并且我们找到所需内容的容易程度(或困难程度)会影响我们对工具本身的看法。

编写好的文档是一项艰巨的任务,但也是一项重要的任务。

考虑到这一点,我们一直在不断改进我们的文档。Deno 是一个大型项目,涉及范围很广,因此我们有很多事情要做,值得庆幸的是,我们得到了社区的大力帮助和反馈。

以下是我们最近为改进文档所做的一些事情,以及我们未来计划做的一些事情。

更好地组织示例

以前,我们的示例分散在文档站点的不同部分和产品中。如果您确切知道要查找的内容,这很好,但使得发现示例和参考资料变得困难。

Better organized examples

现在,我们所有的示例都已在一个地方进行分类和组织。如果您更喜欢通过视频而不是代码示例来学习,您可以过滤您的视图,但您无需在不断增长的文档站点或博客中寻找示例。示例页面是您要去的地方,并且作为我们认为这有多有用的标志,我们已将其添加到文档站点的全局导航中。

更多视频示例

对于那些喜欢通过观看而不是阅读来学习的人,我们添加了一系列视频来介绍使用 Deno 的概念和技术。这些简短易懂的视频证明很受欢迎,我们渴望添加更多。如果您有特别想看到的主题,请告诉我们。我们欢迎您的反馈,并很乐意解决对您最重要的差距。

自从在示例中添加视频以来,我们收到一些人的反馈,他们更喜欢阅读而不是观看,因此我们将为这些视频添加文字稿,并确保有等效的基于文本的教程或示例。我们希望内容尽可能适合多种学习风格。更多视频示例

反馈和建议

除了在 Deno Discord 上与我们聊天(我们甚至有一个专门讨论文档的频道)之外,您现在可以直接在我们的文档站点上提供反馈。每个页面都有一个反馈小部件,您可以在其中告诉我们内容是否有帮助,并分享有关我们如何改进的任何详细信息或建议。

Feedback form

所有反馈都会被收集并在我们每周的文档计划会议中进行审查。我们已经收到了一些非常好的建议,这些建议都有助于使文档对每个人都更好。

简化的侧边栏

有时删除某些内容可以带来最佳改进。通过在一个地方收集我们的示例,我们已经能够从侧边栏导航中删除许多项目。这应该有助于那些浏览站点并寻找特定内容的人,同时又不牺牲对示例的轻松访问。

对比度和易读性

我们发现,我们在站点周围使用的一些颜色在某些组合和字体大小下可能会导致对比度较差。我们做了一些小的但重要的调整,以保持浅色和深色主题下的内容清晰易读,并且对结果感到满意得多。

代码中更多文档

文档站点的某些部分,例如我们的API 参考部分,显示直接从源代码生成的内容。如果源代码包含描述、示例和参考,我们的站点生成器会使用这些内容来创建和填充页面。

More documentation in Code

我们正在积极努力以这种方式添加越来越多的内容,这不仅改进了文档,还将有用的文档直接添加到它所记录的开源代码中,实现了双赢。

更好的移动导航

我们文档的大部分访问发生在桌面设备而不是移动设备上。但是,当我们发现移动设备上查看主导航栏时的一个愚蠢的疏忽时,我们仍然对自己感到恼火。文档站点其他部分的一些主导航栏不可见。不太理想!

我们现在通过改进全局导航栏和站点周围的更好的一致性来修复了这个问题。移动朋友们,快来文档站点的其他部分看看吧!

Better mobile navigation

新的站点生成器

去年,我们采用了新的站点生成器来构建我们的文档。我们选择 Lume 作为工具,以提高我们的灵活性和开发速度。

Lume 正在成为一个非常有能力且设计优雅的站点生成器。它分享了一些熟悉 Astro、Eleventy 和 Jekyll 粉丝的原则,并可以很好地控制您生成和交付给用户的代码。

凭借一套精心策划的插件来扩展核心功能,Lume 在模板、CSS 和 JavaScript 的构建管道方面提供了很大的灵活性,并且具有用于采购和查询数据的周到 API。

我们完成了吗?

没有。虽然我们不断努力改进和完善 Deno 文档中的内容,但我们也将继续致力于用户体验和可发现性。我们不期望我们会真正完成,但希望我们可以不断迭代和改进。

我们感谢所有为站点提供反馈、建议甚至示例的人。感谢大家的所有努力。我们也会继续努力。