跳至主要内容

GitHub 文档最佳实践

遵循以下最佳实践,创建用户友好且易于理解的文档。

关于 GitHub 文档

在 GitHub,我们致力于创建准确、有价值、包容、可访问且易于使用的文档。

在为 GitHub Docs 贡献内容之前,请花点时间熟悉 GitHub 的文档理念和内容设计原则。

编写 GitHub 文档的最佳实践

无论您是创建新文章还是更新现有文章,在为 GitHub Docs 编写内容时,都应遵循以下指南。

将内容与用户需求相一致

在开始之前,了解您为谁写作、他们的目标是什么、文章将解决的核心任务或概念以及要编写的内容类型非常重要。

定义受众

  • 谁会阅读此内容?
  • 他们想做什么?

定义核心目的

  • 阅读完本文后,读者应该能够做什么或理解什么?选择一到两个内容将要讨论的任务或概念。
  • 如果有其他非必需的任务、概念或信息,请考虑是否可以将它们放在文章的较低位置、移至另一篇文章或完全省略。

确定内容类型

根据目标受众和内容的核心目的,确定要编写的哪种内容类型。GitHub 文档使用以下内容类型

例如,使用概念性内容类型来帮助读者了解功能或主题的基础知识以及它如何帮助他们实现目标。使用程序性内容类型来帮助人们从头到尾完成特定任务。

构建内容以提高可读性

使用以下最佳实践来构建内容。在将内容添加到现有文章时,尽可能遵循现有结构。

  • 提供初始上下文。定义主题并说明其与读者的相关性。
  • 以逻辑顺序构建内容,按重要性和相关性排列。按优先级顺序排列信息,并按用户需要信息的顺序排列。
  • 避免长句子和段落.
    • 逐个介绍概念。
    • 每段落使用一个想法。
    • 每个句子使用一个想法。
  • 强调最重要的信息.
    • 每个句子或段落都以最重要的词语和要点开头。
    • 在解释概念时,先从结论开始,然后详细解释。(这有时被称为“倒金字塔”。)
    • 在解释复杂主题时,首先向读者展示基本信息,然后在文章的后面部分披露详细信息。
  • 使用有意义的副标题。将相关的段落组织成部分。为每个部分提供一个独特且准确描述内容的副标题。
  • 考虑使用页面内链接,尤其对于较长的内容。这允许读者跳到感兴趣的区域,并跳过与他们无关的内容。

为可读性而写

让忙碌的用户能够轻松阅读和理解文本。

  • 使用简洁的语言。 使用常见的日常用语,尽量避免使用行话。开发者熟知的术语是可以接受的,但不要假设读者了解 GitHub 的工作原理。
  • 使用主动语态。
  • 简洁明了。
    • 写简短的简单句子。
    • 避免包含多个概念的复杂句子。
    • 删减不必要的细节。

有关相关信息,请参阅 风格指南 中的“语气和语调”以及 编写可翻译的内容

格式化以提高可扫描性

大多数读者不会完整地阅读文章。相反,他们要么扫描页面以查找特定信息,要么略读页面以了解概念的总体情况。

在扫描或略读内容时,读者会跳过大量文本。他们会寻找与他们的任务相关的或在页面上突出的元素,例如标题、说明、列表、表格、代码块、视觉效果以及每个部分的前几个词。

一旦文章有了明确定义的目的和结构,就可以应用以下格式化技巧来优化内容以进行扫描和略读。这些技巧还可以帮助使内容对所有读者更易于理解。

  • 使用文本突出显示,例如粗体和超链接,以突出显示最重要的要点。谨慎使用文本突出显示。不要突出显示文章中超过 10% 的总文本。
  • 使用格式化元素来分隔内容并在页面上创建空间。例如
    • 项目符号列表(可选的内嵌子标题)
    • 编号列表
    • 说明
    • 表格
    • 视觉效果
    • 代码块和代码注释

进一步阅读