编写一本说明手册似乎是一项艰巨的任务,但其实这个任务比你想象的容易多了!下面的步骤适用于任何书面说明手册,从非常简单的说明(如何鼓掌)到非常复杂的说明(如何构建一个半导体)都适用。
01 了解主题很关键。主题也许是很显而易见的,但有关该主题的知识是完成一本成功的手册的关键。比如说,如果你正在编写一本相机使用说明,不仅要知道制光圈和快门速度不仅仅是两个单独的功能,还要知道它们如何相互作用,这样就更容易描述每个功能,因为它与其他功能是相互联系的。
02 和专家谈谈。如果你仅仅是手册作者,而不是该领域的专家,那么在整个过程中你需要有相关知识的人,确保他们审查过你的手册。他们的知识和建议是无价的。
03 试着去实践。如果可能的话,尝试着去实践你写的手册,这样至少你能感觉到使用者想要学什么。
04 研读相关资料。学会该领域的术语,对于你介绍的产品也要研究得精通。 从类似产品的手册中,你能看到其他作者是如何解决这个问题的。 寻找各个作者之间的共同点,这些都是在描述物品时常用的方法及功能。 同时也要找到新的点,尽量脱颖而出。这些通常是一个指定物品的独特功能。你的产品可能会有这些功能,也可能没有,或者可能解决问题的替代方法,你可以对这些进行描述,从而提高产品的价值。虽然你的工作是编写一本指南,但如果能向顾客说明他们购买的物品很有价值,能鼓励他们继续往下读这本指南。 浏览贸易杂志。看看使用这些产品的人们平常如何使用它们的。他们可能希望有些特殊问题能得到解决,如果你的产品能解决这些问题,就需要突出强调。
只要有可能,就解释下你的指令说明!如果你不能插入图片,就举一些常见的例子。例如,在“格式,步骤2”的指令中,看看wikiHow的布局就可以知道目录该怎么做。
即使事情似乎很明显,也要写出步骤!这可以避免给某些不知道这些问题的用户造成麻烦。能增加额外的信息,绝对要比遗漏重要的步骤要好。
如果可以的话,让一个新手做一下测试,使用你编写的手册并记下他们的每个问题!这将帮助你补充一些东西,使你的手册更有用。
如果你正在编写一个非常详细的分章节的手册,如“如何玩笛子”,第一步可能是列出所有的章节:如“选择一个长笛、组装、并护理;发音、指法、你的第一曲”等等。然后你在写每一章时都要用上编写手册的基本准则,因为每一章本身就像一本单独的手册!
在每部分编写在一个单独的纸上(或电脑上),这样更容易编辑。如果有足够空间,并且能找到编辑符号,重新编排就会更容易。在电脑上,在每个步骤之间留出3到4行(按几次“输入”键),这样你可以很容易地找到分段处。