知识库文章的结构

Contributors Contributors 建立于:

这篇文章的视频简介为接下来的内容提供了背景信息和简要概览。通过观看视频,您可以快速判断这篇文章是否适合您。

想掌握为 Mozilla 技术支持撰写帮助文章的诀窍吗?本文通过实例展示常用写作技巧与重要维基标记规范。您既可将本文作为写作指南,也可参考其维基源码进行对照学习。

知识库文章通常分为两类,其引言结构各有特点:

  • 操作指南类:简要说明功能/任务要点及可掌握内容 (示例).
  • 故障排查类:简要描述问题现象及可能存在的解决方案(示例

文章结构设计指南

知识库文章的结构设计遵循技能递进原则:从基础操作到复杂方案分层展开,同时将高频需求信息置于靠前位置。因此,简单通用的解决方案通常排列在复杂或边缘场景方案之前。

撰写描述性章节标题,便于读者要点速览

以任务或解决方案命名章节标题,可使读者快速定位内容范围。通过目录浏览即可预判文章架构,部分用户甚至无需通读全文即可获取所需信息。

撰写分步操作指南

最令人沮丧的莫过于找到所需指南后,却因作者预设了未声明的知识前提而陷入操作困境。因此我们坚持将操作流程分解为完整的编号步骤——即便"点击确定"这样的操作也单独设为一步。 以下以 如何设置主页 文章举例:

  1. 打开您想设为主页的网页。
  2. 将该标签页拖动到工具栏上的主页按钮 Fx89HomeButton 并松开。
    Fx89 Set homepage drag-and-drop
  3. 单击提示框里的 将此网页设为您的主页。

小贴士: 可参考维基源码对照学习。

编写多操作系统及 Firefox 版本的专属指南

Firefox 操作指南常因操作系统而异。我们通过特定维基标记实现动态内容适配:Windows 用户仅见 Windows 操作指引;Linux 用户仅见 Linux 操作指引;Mac 用户仅见 Mac 操作指引。 切换右上角「定制本文」框中的操作系统选项,下方指南将即时更新。此功能示例源自如何知道您的 Firefox 版本文档。

  • 点击菜单按钮 Fx89menuButton,点击 帮助,选择关于 Firefox在菜单栏上,点击 Firefox 菜单,并选择 关于 Firefox 项。 Firefox 关于窗口将打开,浏览器的版本号就列在“Firefox”名称下方。
小贴士: 可参考维基源码对照学习。也可参考该文章学习 {for} 标记使用方法。

在指南中应用模板

Firefox文档中存在大量通用操作步骤。为此我们创建「模板」系统,避免重复撰写(及翻译)相同内容。典型模板通常包含全操作系统指引,可大幅提升步骤编写效率。

以下以如何设置主页文档举例,该文档应用了模板,包含访问 Firefox 设置面板的标准化操作指引。 在屏幕顶部的菜单栏里点击 Firefox 并选择 设置(在旧版 macOS 上选择 首选项)。点击菜单按钮 Fx89menuButton 并选择 设置

  1. 点击主页面板。
    Fx91HomePanel
  2. 点击 主页和新窗口 旁边的菜单,选择显示默认的 Firefox 主页、自定义 URL 或空白页。

小贴士: 可参考维基源码对照学习。 也可参考 如何使用模板 学习模板使用方法.

知识库文档编写规范

获取更多知识库贡献指南,请参阅本页面

此文章在这些用户的协助下写成:

Illustration of hands

志愿者

分享知识并培养专业技能。解答问题并改进我们的知识库。

详细了解