Deno 的文档如何演变
文档是使用工具或服务体验的关键部分。作为开发者,我们常常依赖文档来帮助我们发现工具的功能或学习如何使用其特性,而我们查找所需内容的便捷程度(或困难程度)会影响我们对工具本身的看法。
制作高质量的文档是一项艰巨但重要的任务。
考虑到这一点,我们一直在努力改进我们的文档。Deno 是一个庞大的项目,涉及面广,因此我们有很多工作要做,幸运的是,我们得到了社区的大力帮助和反馈。
以下是我们最近为改进文档所做的一些工作,以及我们未来的一些计划。
更好组织的示例
此前,我们的示例分散在文档网站的不同部分和产品中。如果您确切知道要查找什么,这倒还好,但却很难发现示例和参考资料。
现在,我们所有的示例都已分类整理,集中存放。如果您更喜欢通过视频而非代码示例学习,可以筛选视图,无需再在不断增长的文档网站或博客中四处搜寻示例。示例页面是您需要去的地方,为了表明我们认为它有多么有用,我们已将其添加到文档网站的全局导航中。
更多视频示例
对于那些更喜欢通过观看而非阅读来学习的人,我们添加了一系列视频,介绍使用 Deno 的概念和技术。这些短小精悍的视频很受欢迎,我们很乐意添加更多。如果您有特别想看的主题,请告诉我们。我们欢迎您的反馈,并乐意解决您最关心的不足之处。
自从在示例中加入视频以来,我们收到一些反馈说他们更喜欢阅读而非观看,因此我们将为这些视频添加文字稿,并确保提供等效的文本教程或示例。我们希望内容能够适应尽可能多的学习风格。
反馈和建议
除了在Deno Discord(我们甚至有一个专门讨论文档的频道)与我们交流外,您现在还可以直接在我们的文档网站上提供反馈。每个页面都带有一个反馈小部件,您可以在其中告诉我们内容是否有帮助,并分享任何改进的详细信息或建议。
所有反馈都会在我们的文档规划会议中每周收集和审查。我们已经收到了一些非常好的建议,这些都将帮助我们为每个人提供更好的文档。
简化侧边栏
有时,移除一些东西反而能带来最佳改进。通过将示例集中到一处,我们得以从侧边栏导航中移除大量项目。这应该有助于那些浏览网站并寻找特定内容的人,同时又不牺牲对示例的便捷访问。
对比度与可读性
我们发现网站上使用的一些颜色在某些组合和字体大小下,可能会导致对比度不佳。我们做了一些细微但重要的调整,以确保在亮色和暗色主题下都能保持清晰可读,并且对结果感到非常满意。
更多代码内文档
文档网站的某些部分,例如我们的API 参考部分,会显示直接从源代码生成的内容。当源代码包含描述、示例和参考时,我们的网站生成器会使用这些内容来创建和填充页面。
我们正在积极地以这种方式添加越来越多的内容,这不仅改进了文档,还将有用的文档直接添加到其所记录的开源代码中,可谓一举两得。
更好的移动导航
我们文档的访问量绝大部分来自桌面设备而非移动设备。但是,当我们发现移动设备上查看主要导航时存在一个愚蠢的疏忽时,我们仍然对自己感到恼火。文档网站其他部分的一些主要导航不可见。这不理想!
我们现在已经通过改进全局导航和提高网站整体一致性来修复了这个问题。移动端的朋友们,快来访问文档网站的其他部分吧!
新的网站生成器
去年,我们采用了新的网站生成器来构建我们的文档。我们选择 Lume 作为工具,以提高我们的灵活性和开发速度。
Lume正在成为一个功能强大且设计优雅的网站生成器。它与 Astro、Eleventy 和 Jekyll 的粉丝所熟悉的一些原则相似,并能出色地控制您生成并交付给用户的代码。
Lume 拥有一套精心策划的插件,可扩展核心功能,在模板、CSS 和 JavaScript 构建管道方面提供了极大的灵活性,并拥有深思熟虑的 API,用于获取和查询您的数据。
我们完成了吗?
不。尽管我们不断致力于完善和改进 Deno 文档中的内容,我们也将继续努力改善用户体验和可发现性。我们不期望能真正完成所有工作,但希望能够持续迭代和改进。
我们感谢所有为网站贡献反馈、建议乃至示例的人。感谢大家所做的努力。我们也将继续努力。