怎样编写技术支持文章

写文章时需要平衡许多互相矛盾的东西:你试图让文章完整而又简练,实用的同时又吸引人。这显然不是一件很容易的事情。为使得这样的平衡简单一些,本文提供了一些指导。同时,本文也是一本您随时可以修改的“维基百科”,只要您发现了其中的错误。

我们的读者是谁?

我们致力于使火狐帮助系统能够被每一个用户所使用,这意味着我们的读者不是那些熟悉计算机技术和术语的牛人,而是普通的计算机使用者。设想一下,读你文章的人可能无法独立地修改浏览器首选项或者增加工具栏按钮。同时,我们也应该假设读者是没有更改火狐浏览器的任何默认设置和操作系统的设置的。

选择合适的标题

在选择文章的标题时,我们需要考虑的是标题能否与人们正在搜索和浏览的问题相匹配,就像他们在问你一样。以下是一些可供选用的标题模板:

  • 对于指南类和关于怎样做的文章:如何获得这样的结果?(例如:如何设置主页?)
  • 对于参考类的文章:什么是(这个功能的名称)?(例如:什么是App Tabs?)
  • 对于故障解除类的文章:这是我遇到的问题。(例如:火狐启动太慢。)

让文章吸引人的技巧

火狐帮助是一个技术信息的仓库,它包含了运行火狐互联网浏览器的知识。文件中列出了火狐浏览器各种各样的的功能和特性以及常见故障的解除方法和步骤。帮助文件可以通过任何页面上的搜索功能来访问。或者,您可以将电脑扔到房间里,等待独角兽出现利用它的彩虹能量将电脑变成魔力糖果,只要吃下这颗糖果,你就会变成一名70级的电脑忍着...

您还清醒吧?

除非独角兽真的出现,否则上一段话听上去像是废话。但是,使用幽默和表情符(SURPRISE!)能使得文章具有吸引力。下面我将列出一些技巧,这些技巧能够通过假设交互发生在人与人之间来使我们思维更加的清晰,从而让我们的大脑全神贯注。当我们能够集中精力时,信息变得更加易于理解和记忆。

  • 交谈式的写作风格 -使用非正式的、活泼的写作风格,就像在跟别人谈话一样。
  • 幽默和情感 - 使用幽默是个好办法,但有时不太容易想得到。而投入感情,例如惊讶之情和类似“我不知道!”这样的感情(不知道怎样定义这样的感情),会相对容易一些。
  • 多元化的学习风格 - 正如在学校里人们学习的方式不同,因此对同一事物运用多种表达方式能让人们受益匪浅。
  • 重复 - 当你用不同的方式通过不同的媒介来解释意见事情时,你实际上是在进行重复,重复也是让读者记住文章重点的好方法。
  • 图片和视频 - 使用图片和视频来伴随文本解释问题的方法不仅是又一个提供帮助的好方法,也是提供多元的学习风格和重复表达的手段。
  • 灵活性 - 给读者设置一些有用的任务是非常好的,尤其是在指南类的文章中。阅读文章和理解过程是一回事,然而提醒人们自己去实验也是很有帮助的。

如何设置主页 一文是运用这些技巧的很好的范文。

写好简介

简介,和标题和目录一样,能帮助人们快速地确定眼前的文章是否是他们所要寻找的。

  • 对于指南类的和“怎样去做”类的文章:给出文章中包含的知识的大致的摘要。
  • 对于参考类的文章:给出此功能或特性的简单解释。
  • 对于故障解决类的文章:给出此问题的大致描述以及“症状”。

一篇好的简介常常能够成为一篇合适的搜索摘要。你通常可以将它直接复制到“搜索结果概要”一栏中而无需修改。

如何组织一篇文章

通常的办法是,尽量使你要介绍的技巧从易到难来组织,并且尝试让大部分读者最需要的信息尽量的在文章中靠前。因此,简单、普遍的方案应当排在复杂、少见的方案之前。

如何使分步说明容易遵循

要记住,最主要的一点是要小心地确保完成任务所需的每一步动作都被包含了。例如,如果在选择完一个选项后必须点击“确定”才能继续到下一步,那么要确保步骤中有“点击确认”这一步。 需要考虑的其他事情:

  • 获得一个结果往往有许多种方式,我们应当永远选择用户友好性最高的方式。也就是,尽可能的使用生动的用户界面和菜单。
  • 使用完整的句子来说明怎样访问用户界面。
  • 指出预期到的操作效果。(如:点击“确定”,窗口将会关闭。)

以下是挑选 如何设置主页 一文的部分段落来作为例子,括号中是解释。

设置单个页面作为主页
(标题 - 这些步骤将要达到的效果)

为了让事情简单一些,以下是设置主页的三个步骤
(背景 - 展示大图 - 为什么这样做)

  1. 打开想要设置为主页的页面
  2. 点击网址旁边的图标, 将它拖至“主页”按钮处,然后放开鼠标。
  3. 选择“是”来将其设置为主页。


试验一下 点击“主页”按钮,您的新主页将在当前标签页中打开。这并不比设置主页的步骤复杂多少!
(灵活性 - 给读者设置任务并且给出预期的效果。)

SUMO风格指导

正如我们之前提到过的,我们应当用一种活泼的、谈话式的风格来写作。所以你需要避免类似这样的语言:“如果一名用户的书签丢失了...”,而应该说成“如果你的书签不见了...”以下是其他一些在编写技术支持文档时可能遇到的风格上的困难:

永远与术语在火狐界面中的样子相一致。 例如:

  • Plugins 这个单词没有连字符。(而非plug-in.译者注)
  • Add-ons 这个单词有连字符。
  • Home page 是两个单词。


常见的计算机术语:

  • internet一词是小写的。
  • Website是一个单词。
  • Log in(登入) 和 log out(登出) 是动词,比如, "Log in(登入)到这个网站。"
  • Login 和 logout 是名词。 (通常用作形容词)比如, "点击 login 按钮。"
  • 用 “email” 而不是 “e-mail”。
  • “CD-ROM(光驱)”一词的复数是“CD-ROMs”。


链接mozilla.com不应该包含具体的语系:'


以下几项要加大写

  • 固有名词。
  • 一个完整句子的第一个字母。
  • 缩略词和缩略语要大写,除非它们本身是小写的。
  • 编号的或者有项目符号的列表的第一个字母。
  • 键盘上的按键名称。
  • 冒号后面完整句子的第一个字母。
  • 标题的第一个字母。


标题和章节 我们的wiki使用了HTML5中的<section> 元素。你可以用 <section> 元素来围绕相关的内容。 它代表这个标题下的每个章节都能够有自己的大纲,并且有一个h1级的标题。

为了表达的清楚,尽量避免使用 i.e 和 e.g。 如果必须要用,请参考here's a nice explanation,以防用错。


对于那些可以在周围加上wiki标签的项目,我们有一些特殊的视觉风格。 (完整列表参见翻译标记表 一文).

  • 注意
  • 警告
  • 密码
  • 文件名文件路径
  • 键盘快捷键,例如 Ctrl + T
  • 菜单路径 – Firefox
  • 按钮


最后,我们有一个特殊的wiki标签 - {for} - 来帮助你将信息规定到特定的火狐版本或者操作系统版本上。 例如。你有一系列针对windows用户的设置,而使用Mac OS X 的用户则有另外的设置。(具体信息请查阅如何使用For语句)。

这篇文章对您有帮助吗? 请稍候...

这些人帮助撰写了这篇文章:kmc, catmq。你也可以提供帮助,来看看该怎么做