Skip to main content

操作方法内容类型

介绍如何使用 GitHub 产品和功能完成任务。

操作说明包含描述如何使用 GitHub 产品完成任务的编号步骤。 通常,它们是必要的,以最大限度地利用 GitHub。

操作指南文章重点介绍完成任务的最低基本步骤。 它们可能会链接到其他内容类型作为先决条件(特别是概念或参考)或后续步骤(尤其是教程)。 为了符合我们的链接策略,仅当明确有用且必要时,才应使用这些策略。

通常,步骤之前包括 1-2 个简短的介绍性句子是可以的。 如果需要多个句子以外的更多解释,请考虑将信息添加为概念性文章。

故障排除是其自己的内容类型,但操作方法文章可以包含简短的故障排除部分,这有助于用户完成任务。

操作指南文章标题

以任务为基础的操作指南文章的标题和部分以动名词开头。

  • 使用:“申请学生开发者包”时,尽量使用生动且明确的动词(必要时请参考同义词库)。 标题专门描述文章或标头中包含的任务,但通用性足以反映所有内容。

操作说明文章短标题使用简短的非繁琐谓词短语。 短标题显示在边栏导航中。

  • 使用:“管理计划”或“通过 Copilot 创建问题”

操作说明注意事项

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

  • 遵循 风格指南 中过程步骤的样式准则。
  • 操作方法内容可以重复查找将相关内容分组到单个较长的文章中的机会。
    • 将多个相关的操作方法分组到单个文章中,除非有一个令人信服的理由不这样做。
    • 如果禁用设置或撤消任务需要相同的步骤,并且没有任何特殊影响,请不要编写单独的操作方法。
    • 如果禁用设置或撤消任务需要不同的步骤或具有重要或特殊含义,请创建更长的文章来包含操作方法。
  • 始终包括操作方法的预期结果(通常这是标题)。
  • 在已知痛点中包含故障排除提示。

操作方法内容的示例

  •         [AUTOTITLE](/actions/using-workflows/using-starter-workflows)