文章审批指南
修订信息
- 修订编号: 300744
- 创建于:
- 创建者: 普莱是袋熊
- 备注: 彻底重新翻译
- 已审阅: 是
- 已审阅:
- 审核人: wxie2016
- 已核准? 是
- 是否为最新修订? 否
- 可进行本地化: 否
修订原文
修订内容
我们的知识库审阅员是由具有撰写支持文档经验与技能的 Mozilla 贡献者和员工组成的专业团队。以下是审阅文章时的一些重要指南。
目录
审阅文章
大多数修订版都是由人们自愿投入时间和精力完成的。在处理他人提交的工作时,请始终假定每个人都有良好的意图,并务必对他们所做出的贡献表示感谢。请牢记,您可能是该贡献者接触到的第一位,甚至是唯一一位来自 Mozilla 的联系人。因此,请务必给对方留下积极且友好的印象。
知识库仪表板概览根据过去30天的访问量对文章进行了排序。“状态”列清晰地标注了哪些文章需要审阅。所有修订版都应得到及时的审阅,而不仅仅是那些热门文章。
未审阅的更改列表是查看哪些文章需要审阅的另一种方式,同时也能直观地看到哪些修订版等待审阅的时间最长。如果您从下拉菜单中选择特定产品,还可以按“最新”对列表进行排序。
热门文章
我们的热门文章(每月访问量超过10万次,其中大约有20篇是关于桌面版Firefox的文章)占知识库总访问量的约50-55%。我们的顶级Android文章是每月访问量超过5,000次的文章。
确保这些文章包含最新信息至关重要。
由于热门文章经过大量编辑且影响大量用户,对文章的重大更改应首先进行讨论。欢迎私下联系其他知识库贡献者请他们参与意见。最好能达成共识,但这有时很难确定。一如既往,请运用您的最佳判断。
- 对于重大更改 — 如果您的修订版涉及重大更改,请不要自行批准。请严格遵循以下文章批准指南。如有需要,可在文章讨论主题中发起讨论。
其他文章
桌面版每月访问量低于10万次的文章(或Android访问量低于5,000次)构成了我们知识库的绝大部分内容(约600多篇文章;占总访问量的45%到50%)。这些文章涵盖了不太常见的问题以及较新的产品。请严格遵循以下文章批准指南。
新文章
当我们首次创建一篇文章时,它没有任何访问量。那么您该如何处理呢?
- 如果文章是为特殊目的创建的,例如用于Firefox紧急修复版本发布、被链接自某产品页面或mozilla.org,或者属于预设回复,请将其视为热门文章同等对待。
- 如果没有任何理由认为该文章会立即变得非常受欢迎,请将其视为普通文章,即桌面版访问量低于10万次/月或Android访问量低于5000次/月的文章。如果修订版有改进之处,请批准它。文章不必达到100%完整。如果它不是热门文章之一,可以在继续完善的同时开始收集用户反馈。
- 如果新文章已经获得批准但发布未满一个月,可以考虑查看其7天视图(访问量)来评估其表现。
特殊文章
- 模板包含在多个文章中重复使用的内容,应被视为热门文章。所有模板(包括需要审阅的模板)都列在这里。更多指南请参见使用模板。
- 预设回复在支持论坛中的重要性远远超出了其访问量所体现的。对于新的论坛回复,或者任何超出微小更正或澄清范围的更改,应视为重大更改。所有论坛回复(包括需要审阅的)都列在此页面。更多指南请参见创建或改进常用论坛回复。
文章审阅和批准指南
在 SUMO(Mozilla 支持平台)上创建卓越内容对于建立用户信任和提升我们的信誉至关重要。为了确保所有知识库内容都达到高质量、准确性和一致性的标准,我们已对所有知识库内容实施了审阅要求,无论作者是谁。
每当对知识库内容进行修订时,该修订必须至少经过一轮审阅。此审阅可由员工或同行贡献者进行,具体取决于产品。即使是员工创建的内容也需要经过此审阅流程,尽管员工的批准本身可能发生在 SUMO 之外。
为确保清晰明了,我们在下方提供了关于哪些产品需要员工专属批准,以及哪些可以由共同贡献者批准的详细信息。
通过遵循这些审阅和批准实践,我们可以确保 SUMO 上的内容始终维持高质量和准确性,为用户提供可靠且有价值的信息。
内容审阅指南
所有内部员工必须确保其英文内容至少经过另一方的审阅。内容审阅者可以包括产品支持经理、产品经理、法务团队、市场团队、公关团队或社区贡献者等。
内容审阅可以在 SUMO 内部进行,也可以在 Google 文档中完成。如果您的审阅是在 SUMO 之外完成的,请在您的 SUMO 修订版说明中添加注释,提及给予批准的团队或个人。请参考以下示例。
请勿自行批准您自己的英文修订版,除非是纠正先前已批准内容中的错误,或者更改仅涉及不影响操作说明的次要细节。其他内容更改请耐心等待其他贡献者或员工进行审阅。(见下文修订级别)。
最近的en-US修订版和未审阅的更改将由员工和贡献者每周至少进行三次审阅。待处理的修订版应在无需额外联系的情况下被批准或暂缓批准。如果没有立即批准的紧急理由,应给予合理的时间(七天或更长),之后编辑方可联系员工或其他审阅者(如果不需要员工批准)。
在某些情况下,可能会出现需要员工审阅和批准的例外内容。在这种情况下,作者会在修订版说明中注明“需要员工审阅”。如果您恰好提议对这类文章进行修订,请务必将其标记给员工撰稿人(通过 SUMO 私信或 Slack),以便他们能够提供必要的审阅和批准。
通过携手合作并让其他人参与审阅和批准流程,我们可以维持最高的质量标准,并确保我们的内容始终处于顶尖水平。感谢您的合作,让我们继续为用户打造卓越的修订版!
审阅要求矩阵
产品 | En-US 自我批准 | En-US 共同贡献者批准 | En-US 仅限员工批准 |
Firefox 桌面版 | 否 | 是 | 否* |
Firefox Android/iOS版 | 否 | 是 | 否* |
Focus Android/iOS版 | 否 | 是 | 否* |
Thunderbird | 否 | 是 | 否* |
Firefox 企业版 | 否 | 是 | 否* |
Mozilla 账户 | 否 | 否 | 是 |
* 除非作者在修订版说明中注明“需要员工批准”。
具有特殊要求的文章
文章 | En-US 自我批准 | En-US 共同贡献者批准 | En-US 仅限员工批准 |
如何自定义 Firefox Suggest 设置 | 否 | 否 | 是 |
订阅/付费产品
请勿自行批准您自己的修订版,也勿批准其他贡献者的修订版(仅限英文版)。这同样适用于订阅或付费产品的预设回复和模板。如果您建议进行修订,请将其标记给员工撰稿人以获得批准(可通过 SUMO 私信、Matrix 或 Slack 联系)。
通过携手合作并确保员工撰稿人参与付费产品内容的批准流程,我们能够持续优化内容,使其更好地服务于我们的客户。
审阅要求矩阵
产品 | 自我批准 | 共同贡献者批准 | 仅限员工批准 |
Mozilla VPN | 否 | 否 | 是 |
Firefox Relay | 否 | 否 | 是 |
Monitor | 否 | 否 | 是 |
否 | 否 | 是 | |
MDN Plus | 否 | 否 | 是 |
Hubs | 否 | 否 | 是 |
遵守审阅指南
创建一致、准确且相关的内容固然至关重要,但这仅仅是整个流程的一部分。为了确保我们的内容能够长期保持高质量,我们需要所有相关人员深刻理解并严格遵循审阅与批准流程。我们的员工将密切关注新指南的执行情况,以确保一切顺利推进。
为保留您的知识库审阅员权限:
- 遵守上述审阅指南。
- 遵守社区参与指南。
- 每月至少审阅三个文章修订版。
如果您自行批准英文(en-US)内容,或者在连续60天或更长时间内未审阅任何文章修订版,您作为审阅员的知识库审阅权限可能会被撤销。在采取任何撤销权限的措施之前,员工会与审阅员沟通,以确认是否存在合理的不合规原因。通过这种方式,我们旨在鼓励团队合作,确保内容的高质量,并营造一个让每个人的专业知识都能为我们的成功贡献力量的环境。
什么是现有内容的更新?
知识库中最常见的任务是保持文章更新。通常包括:
- 拼写和语法更正
- 简化现有语言,去除行话
- 更新或添加截图
- 更新或添加屏幕录像
- 移除我们不再支持的Firefox版本的内容
- 更新分步说明以支持新版本的Firefox
- 更新现有文本以支持新版本Firefox中的更改
- 修复Wiki标记问题
- 修复链接
- 更新关键词
- 添加或更新搜索摘要
什么是重大更改?
重大更改是那些从根本上改变现有文章的更改。它们包括:
- 添加新章节
- 删除现有章节
- 大量重写(不仅仅是简化和去除行话)
- 重写章节标题
- 重新排序章节
- 改变文章的范围
修订级别
当您批准一篇文章时,您有三个不同的修订级别可供选择:
- 不影响操作说明的次要细节:这些更改不会影响提供给用户的操作说明。本地化人员不会收到关于这些更改的通知。
- 不需要立即翻译的内容更改:这是默认选项。这些更改属于重要更新(包括更新和重大更改),但不会使文章的先前版本完全失效。
- 会使旧翻译不准确的主要内容更改:这种情况极为罕见,仅适用于文章存在严重错误,若不进行这些更改,可能会给用户带来重大问题。在这种情况下,将在本地化文章上添加警告,提示内容可能已过时,并提供英文版本的链接。
给编辑的反馈
在批准文章时,感谢编辑的贡献至关重要。如果您能给予他们反馈,那就更好了。他们的写作水平是否有所提升?他们在解释复杂内容方面是否表现出色?请务必告诉他们!
若修订内容不仅存在简单错误,或是未经讨论就对热门文章进行重大修改,又或是您认为该修订无实质帮助,则应选择延期批准。但需注意,延期批准并非简单拒绝,而是您与编辑协作完善修订内容的机会。因此,请先向编辑致谢,随后具体说明您认为需要修改的内容,并提出建设性意见以确保修订达到批准标准。
除在延期批准时填写评论外,您还可以:
- 在文章讨论区创建主题帖,提供更详细的说明。
- 指引编辑查阅该讨论帖。
- 务必附上相关文章讨论或指导规范的链接。
审阅多个修订版
批准最新的修订版并不意味着您同时批准了之前待审阅的早期修订版。当存在多个修订版等待批准时,请务必在决定批准其中任何一个之前,仔细检查所有待审的修订版。一旦较新的修订版获得批准,您将无法再审阅较早的修订版。尽管这些早期修订版仍会显示为“等待批准”,但您将无法对其进行进一步的审阅。
准备好进行本地化
将文章修订版标记为“准备好进行本地化”,可以明确告知本地化团队英文版本已经定稿,可以安心开展翻译工作,无需担心在翻译过程中文章内容会再次变动。
- 当您批准一个修订版时,如果所有需要的更改(需要更改注释、文章讨论论坛)已完成,并且没有计划在当前或下一个版本中进行更多更改,请将文章标记为准备好进行本地化。**
本地化是一项艰巨的任务,通常由个人独立完成。在某些语言环境中,往往只有大约前20篇文章会被本地化。我们的热门文章通常仅在为新的Firefox版本进行更新时才需要更改。由于我们能够提前知晓即将发布的内容,因此我们会尽量确保在Firefox发布前完成所有必要的更改,从而为本地化人员争取更多时间来完成他们的工作。
如果您在批准修订版时未将其标记为准备好进行本地化(如上述情况),您可以随时点击文章修订历史记录中R列下的“未准备好进行本地化”状态条目(一个X符号)进行确认,将其标记为准备好。
标记为RFL的修订版会有一个勾选符号。
“准备好进行本地化” 如何运作?
为了避免有人在文章状态不稳定时进行翻译,当您点击“翻译文章”时,系统会提供最近标记为“准备好进行本地化”的版本。只有当文章的新修订版获得批准,并且该修订版被标记为第二或第三修订级别同时选中了“准备好进行本地化”标志时,文章才会被添加到本地化仪表板中作为需要更新的内容。此外,系统还会向所有关注“准备好进行本地化”文章的人员发送电子邮件通知。
下一版本内容
涵盖下一版本内容的文章,要么是全新的文章,要么是对现有文章的内容更改,主要介绍下一版本中引入的新功能。以下指南适用于包含与发布相关的内容的文章。
基于发布的知识库编辑时间表
下一版本发布前4周
- 规划和起草下一版本的内容;本地化人员目前无需着手处理下一版本的工作。
- 所有现有内容仍照常开放供编辑和本地化;请优先专注于本地化最新或最受欢迎的内容。
下一版本发布前3周
- 下一版本内容在本周末前完成;本地化人员目前无需着手处理下一版本的工作。
- 所有现有内容仍照常开放供编辑和本地化;请优先专注于本地化最新或最受欢迎的内容。
下一版本发布前1-2周
- 针对下一版本的内容更改已在英文版本中完成,本地化人员应专注于翻译这些内容。
- 所有其他现有内容的优先级有所降低,但仍可照常进行编辑和本地化。.
需要更改 (Needs changes)
在批准修订版时,您需要判断是否还有需要更改的地方。如果“需要更改注释”中提到的所有内容均已处理完毕,您可以取消勾选该选项(清除注释),并批准文章。如果仍有待完成的事项,请确保该复选框保持勾选状态,并更新注释。这样,我们可以轻松跟踪文章上需要完成的工作。
给予贡献者署名
有时,参与文章讨论的人员即使没有实际编辑Wiki,也对修订版做出了重大贡献。在这种情况下,您可以编辑文章的贡献者列表(在文章历史记录页面上)以将他们包括在内。让他们知道您这样做了是额外的奖励!
要添加贡献者,请转到文章的显示历史记录 (Show History)页面。向下滚动到修订版下方,点击“编辑贡献者 (Edit contributors)”链接,输入贡献者名称,然后点击
。垃圾信息和错误编辑
如果发现是垃圾信息,您只需在文章修订历史记录中点击“垃圾桶”图标并确认,即可删除该修订版。如果是错误提交(无实质性更改)或误放在帮助请求中的内容(编辑内容本质上是一个支持问题),您应暂缓批准,并在评论中包含以下消息:
您好。
看起来您可能是在尝试获取有关Firefox的帮助。如果是这样,请在此处https://support.mozilla.org/questions/new重新提问,以便我们更好地帮助您。
给您带来不便,我们深表歉意。
完成此操作后,您可以删除该修订版。