跳至主要内容

概念内容类型

人们在学习全新事物时,最常使用概念内容。

概念内容通过提供清晰的高级概述、阐释该功能或主题如何帮助用户以及案例或示例等上下文,帮助人们理解功能或主题。

我们编写概念文章以及其他文章中的概念章节。大多数主要产品、功能或主题都有自己的概念文章。

如何编写概念内容

有关概念内容模板,请参阅 模板

  • 用通俗语言描述该功能、产品或主题是什么。
  • 说明它的用途以及为何对读者有用。
  • 分享使用案例或示例。
  • 如有必要,描述该功能或主题的工作原理(注意受众并将深入的技术细节放在合适的位置)。
  • 突出读者使用该功能需要了解的细节。
  • 包含使用该功能的后续步骤(可以是进一步阅读的链接或文章内部的内容)。

概念内容的标题

  • 概念文章或概念章节的标题应以“关于[主题]”开头。
  • 使用名词来描述主题。
    • 使用:“About code scanning”
    • 避免:“About scanning your code for vulnerabilities”

概念内容示例

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