概念性内容通过提供清晰的高级概述、对功能或主题如何帮助他们在旅程中取得成功的解释以及用例或示例等上下文,帮助人们理解功能或主题。
我们创建概念性文章以及其他文章中的概念性部分。大多数主要产品、功能或主题都有自己的概念性文章。
如何撰写概念性内容
有关概念性内容模板,请参阅“模板”。
- 用通俗易懂的语言描述功能、产品或主题。
- 描述其目的以及它对读者有何用处。
- 分享用例或示例。
- 如果相关,请描述该功能或主题的工作原理(注意受众和深入技术细节的正确位置)。
- 突出显示读者使用该功能需要了解的任何细节。
- 包括开始使用该功能的后续步骤(无论是通过进一步阅读链接还是文章本身的内容)。
概念内容的标题
- 概念性文章或概念性部分的标题以“关于 [主题]”开头。
- 使用名词来描述主题。
- 使用:“关于代码扫描”
- 避免:“关于扫描您的代码以查找漏洞”
概念内容示例
- 概念性文章
- 其他文章中的概念性部分
- “关于安全策略”在 将安全策略添加到您的存储库 中
- “关于维护模式”在 启用和安排维护模式 中