Contributors
Contributors
最后更新于: 04/21/2024
"关于" 类文章是 SUMO 的基本面。它们的目的是回答 "什么是…" 的问题,帮助用户了解关于产品、功能和服务的基本信息。这些文章提供了全面的概况或简介,而不去深入讨论过程或故障排除的细节。
什么时候需要撰写 "关于" 类文章
在以下情形下,请考虑撰写一篇 "关于" 类文章:
- 介绍一个新产品、功能或服务。
- 解释一个概念或功能对理解如何有效使用一个产品非常重要。
- 现有产品或功能有了重大升级或更新,需要新的解释。
撰写 "关于" 类文章的最佳实践
- 了解读者:通常,"关于"类文章的读者不那么熟悉 Mozilla 产品技术术语或复杂性,所以文章应该使用浅显易懂的通俗语言。
- 从明确的定义开始:使用明确和简要的定义来介绍你的产品、功能或概念作为开始。避免使用未经解释的术语。
- 解释重点:在定义对象之后,说明为什么它很重要、它如何使用户受益?为什么要开发这个产品、功能或服务?
- 提供场景:帮助用户理解这个产品、功能服务位于 Mozilla 生态的什么位置。
- 使用实例:实例有助于澄清复杂的概念。如果可能,在文章中包含一些实际的例子来演示具体使用或影响。
文章结构
- 标题:文章的标题应该适合文章要讲的内容以及用户搜索的目标。 标题要使用句子的大小写规则。标题不要超过60个字符,因为谷歌搜索一般只显示前50到60个标题字符。请简明扼要并且针对用户。
- 摘要:摘要文章的概况,它帮助读者很快了解该文章是否是他们所需。摘要应该是所述概念的简介以及用户关心的重点。摘要需控制在140个字符之内,因为搜索引擎会忽略超出的内容。
- 主体内容:请避免构建冗长的段落和文字。使用 H2 作为小节题目。请按照下面的小节逻辑划分主体内容:
- 段落
- 无序号列表(有序号列表作为 “任务” 类文章的列表)
- 表格
- 图形(截图或GIF)
- 了解更多信息的链接:请使用 H3 作为更多信息的标题,这样它就不会出现在目录中。请使用无序号列表,而且链接数目不要超过4个。