本指南说明了在您创建一篇新的知识库文章时如何填写文章描述(也称“文章元数据”),以及知识库审阅者如何在您的提交获批后更新此信息。
目录
文章元数据
文章元数据是一组有助于对文章进行分类的信息,以便读者可以更轻松地找到它。
标题
文章的标题应清楚地描述文章向读者展示的内容。避免以如何一词作为标题的开头。由于大多数文章都提供操作指导,因此以“如何”开头会使按字母顺序排序变得困难和混乱。例如,不要使用“如何更改新标签页背景”,而应使用“更改新标签页背景”。有关如何选择文章标题的更多信息,请参阅本文的这一节。
按文章类型划分的标题要求
不同类型的支持文章有特定的要求,以确保标题对用户清晰有用。
- 操作方法类文章:使用动词来清楚地表明任务。例如:“更改您的新标签页背景”。
- 关于类文章:侧重于所解释的概念或功能。例如:“了解 Firefox 扩展”。
- 故障排除类文章:描述问题并包含面向操作的解决方案。
- 常见问题解答类文章:清楚地说明主题或常见问题。例如:“Mozilla VPN - 常见问题解答”。
有关每种文章类型的具体写作指南,请参阅:
Slug
Slug 是文章的链接。请保持简短。“Joining a Conversation”的 slug 可能会变成“joining-conversation”。
分类
根据本文的用途选择一个分类。本文是否向读者展示了如何使用 Mozilla 产品做某事?选择 。它是否有助于解决故障排除问题?选择 。
允许翻译
选中此选项以允许翻译文章。此设置默认启用。
产品
本文与什么相关?它是否与 Firefox、Firefox for Android 或 Firefox for iOS 相关?选择所有适用的选项。
您选择的产品将决定可用的主题选项。例如,如果您选择 Firefox,您将无法选择 Thunderbird 特有的主题。
主题
可用的主题选项取决于您选择的产品。选择适用于文章的最具体的主题。例如,如果文章是关于书签的,请选择书签。父主题(在本例中为“浏览”)将被自动选中。
如果适用,您可以选择多个主题。
允许对此文章进行讨论?
选中此选项以允许文章讨论。此设置默认启用。
相关文档
大多数文章都与其他文章相关。输入相关文章名称的开头部分。Kitsune 会自动查找您可以点击的相关文章。
关键词
关键词可以通过添加文章的搜索结果摘要中未包含的术语来改善搜索结果。
搜索结果摘要
摘要简要介绍了文章的内容,以帮助用户判断他们是否找到了正确的文章。提供概念的文本概述或定义,并介绍常见问题解答。将摘要限制在 140 个字符以内,因为搜索引擎可能会截断更长的内容。
如何编辑文章元数据(仅限审阅者)
知识库文章提交获批后,只有审阅者可以更新其元数据。如果您有审阅者权限,可以通过点击“编辑工具”下的 按钮来访问此页面,以打开“编辑文章元数据”页面。在继续操作之前,请确保您已登录 Mozilla 支持。
在这里您可以:
- 更改文章的标题、slug、分类、产品和主题。
- 归档或取消归档文章(由过时:复选框控制)。
- 允许或禁止文章讨论(允许对此文章进行讨论?复选框)。
- 添加或删除需要更改:条目或评论。
- 更改相关文档:条目。
完成更改后,点击 ;否则您的更改将不会被保存。
更多信息
- 有关撰写文章的帮助,请参阅 怎样编写技术支持文章。
- 要了解如何创建新文章,请参阅 创建新的知识库文章。
- 要提交小更新,请参阅 编辑知识库文章。
- 有关审阅者指南,请参阅 文章审批指南。
查找更多关于知识库贡献的指南。