跳至主要内容

操作指南内容类型

解释如何使用 GitHub 产品和功能完成任务。

操作指南包含描述如何使用 GitHub 产品完成任务的编号步骤。通常,它们是充分利用 GitHub 所必需的。

操作指南文章专注于完成任务的最少必要步骤。它们可以链接到其他内容类型作为前置条件(尤其是概念或参考),或作为后续步骤(尤其是教程)。根据我们的链接策略,仅在明确有用且必要时才使用这些链接。

通常在步骤之前加入 1–2 句简短的介绍是可以的。如果需要的解释超过几句话,请考虑将信息另作概念文章添加。

故障排除是独立的内容类型,但在帮助用户完成任务时,操作指南文章可以包含简短的故障排除章节。

操作指南文章的标题

操作指南文章的标题和章节基于任务,且以动名词开头。

  • 示例:“申请学生开发者套餐”。使用主动且具体的动词(必要时进行头脑风暴或使用同义词词典)。标题应明确描述文章或标题所包含的任务,但要足够概括以覆盖全部内容。

操作指南文章的短标题使用简短的非动名词动词短语。短标题会显示在侧边栏导航中。

  • 示例:“管理你的计划”或“使用 Copilot 创建议题”。

操作指南注意事项

有关操作指南内容模板,请参阅 模板

  • 请遵循 《样式指南》 中关于程序步骤的样式规范。
  • 操作指南内容可能会出现重复——请寻找机会将相关内容合并为一篇更长的文章。
    • 除非有充分的理由分开,否则应将多个相关的操作指南合并为一篇文章。
    • 如果禁用设置或撤销任务所需的步骤相同且没有特殊影响,请勿单独撰写一篇操作指南。
    • 如果禁用设置或撤销任务需要不同的步骤,或具有重要或特殊的影响,请创建一篇更长的文章来囊括这两个操作指南。
  • 始终列出操作指南的预期结果(通常即为标题)。
  • 在已知的痛点处加入故障排除提示。

操作指南内容示例

© . This site is unofficial and not affiliated with GitHub, Inc.