跳至主要内容

GitHub 文档最佳实践

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

关于 GitHub 文档

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

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

GitHub 文档撰写最佳实践

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

根据用户需求调整内容

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

定义目标受众

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

定义核心目的

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

确定内容类型

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

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

构建易读的内容结构

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

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

撰写易读的内容

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

  • 使用通俗易懂的语言。尽可能使用常见、日常的词语,并避免使用术语。开发人员熟知的术语是可以的,但不要假设读者了解 GitHub 的工作原理。
  • 使用主动语态。
  • 简洁明了。
    • 写出简单明了的句子。
    • 避免包含多个概念的复杂句子。
    • 精简不必要的细节。

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

格式化以方便扫描

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

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

一旦文章具有明确定义的目的和结构,您可以应用以下格式化技术来优化内容以供扫描和略读。这些技术还可以帮助使所有读者都能更好地理解内容。

  • 使用文本突出显示(例如粗体和超链接)来引起读者对最重要点的注意。谨慎使用文本突出显示。不要突出显示文章中超过 10% 的文本。
  • 使用格式化元素分隔内容并在页面上创建空间。例如
    • 项目符号列表(可选带缩进式副标题)
    • 编号列表
    • 警报
    • 表格
    • 视觉效果
    • 代码块和代码注释

进一步阅读