概念性内容通过提供清晰、大致的概述,解释功能或主题如何帮助用户完成用户旅程,以及提供用例或示例等上下文,帮助用户了解功能或主题。
我们在其他文章中创建概念性文章和概念性部分。 大多数主要产品、功能或主题都有自己的概念性文章。
如何编写概念性内容
有关概念内容模板,请参阅“模板”。
- 用简单语言描述功能、产品或主题。
- 描述它的用途以及它为什么对读者有用。
- 共享用例或示例。
- 如果相关,请描述功能或主题的工作原理(注意受众和适当的位置,以便深入了解技术细节)。
- 突出显示读者使用该功能需要知道的任何详细信息。
- 包括开始使用功能的后续步骤(是否通过延伸阅读链接或文章本身中的内容)。
概念性内容的标题
- 概念性文章或概念性部分的标头以“关于 [主题]”开头。
- 使用名词来描述主题。
- 使用:“关于 code scanning”
- 避免使用:“关于扫描代码中的漏洞”
概念性内容示例
- 概念性文章
- 其他文章中的概念性部分
- 将安全策略添加到存储库 中的“关于安全策略”
- 启用和排定维护模式 中的“关于维护模式”