本教程的第 1 部分向您介绍了技术文档中最常见的内容类型。您还以读者的身份评估了一个真实示例,并且您可能已经意识到标题对于良好的阅读体验至关重要。这是因为网络上的读者不会阅读——他们只是浏览¹。人们在网络上的阅读速度实际上要慢 25% ²,而且他们只阅读了页面上 20% 的内容³。(这些数据来自 2008 年;我很害怕知道今天的百分比。)
技术文档中的标题充当蓝图和地图。组织标题称为 丹麦 whatsapp 电话号码列表 内容结构,标题通常用于自动生成目录,读者通常会浏览目录以了解文档中的主题。
好的标题+好的结构=易于浏览
无论页面是在 Google Docs 之类的东西上显示,还是在功能丰富的网站上显示,还是在移动设备上显示,此等式都是正确的。如果我没有使用有用的 h1、h2 和 h3 标题,甚至您阅读这篇文章的体验也会大不相同。
为了成为一名更好的作家,我不断阅读新的技术文档(提示,提示),多年来我注意到了一些常见的标题。这些标题可用于不同类型的内容,并且往往对读者更有帮助。例如,“一目了然”。标题的组织特定于内容类型和读者的目标,您将在备忘单中看到。
对于每种内容类型,我都列出了常用标题和各种选项,以便在备忘单中组织它们(特定于应用程序的标题带有下划线)。我没有包含入门指南和运行手册的选项,因为文档格式和内容是特定于团队的。

入门指南
大多数入门指南的标题都是“入门”或“快速入门”。由于标题中有“入门”一词,因此读者希望在指南结束时开始使用该应用。入门指南的结构和标题应确保读者实现此目标。否则,读者可能会感到困惑,并放弃使用该应用。