概念性内容通过提供清晰、大致的概述,解释功能或主题如何帮助用户完成用户旅程,以及提供用例或示例等上下文,帮助用户了解功能或主题。
我们创建概念文章,以及其他文章中的概念部分。 大多数主要产品、功能或主题都有自己的概念文章。
在项目或分区之间做出决定
操作说明或教程可以在步骤之前有 1-2 个简短的介绍性句子。 如果某个内容需要用两三句话以上来解释,这时我们就应该考虑是否值得在概念性文章中单独说明。
但是,我们应该有选择。 并非每个概念或“关于 X”部分都需要自己的文章。 通常,这取决于我们需要包含多少对用户有用的信息。
如何编写概念性内容
有关概念内容模板,请参阅 模板。
- 用简单语言描述功能、产品或主题。
- 描述它的用途以及它为什么对读者有用。
- 共享用例或示例。
概念性内容的标题
文章的短标题应该是一个单词或名词短语。 如果文章出现在侧边栏的“概念”下,请避免使用“关于”,除非该文章位于同名标题下。 示例:“编程代理”和“关于编程代理”。
文章中概念部分的标题以“关于 [主题]”开头。
- 使用名词来描述主题。
- 使用:“关于 code scanning”
- 避免使用:“扫描代码漏洞”标题
概念性内容示例
- 概念性文章
- 其他文章中的概念性部分
- 将安全策略添加到存储库 中的“关于安全策略”
- 启用和排定维护模式 中的“关于维护模式”