如何编写一本手册

下载PDF文件

下载PDF文件

在本文中：

了解主题

设计手册的布局

开始编写

格式

显示其它1点...

显示较少内容...

相关文章

编写一本说明手册似乎是一项艰巨的任务，但其实这个任务比你想象的容易多了！下面的步骤适用于任何书面说明手册，从非常简单的说明（如何鼓掌）到非常复杂的说明（如何构建一个半导体）都适用。

步骤

方法 1

方法 1 的 4:

了解主题

下载PDF文件

1. 
   1
   了解主题很关键。主题也许是很显而易见的，但有关该主题的知识是完成一本成功的手册的关键。比如说，如果你正在编写一本相机使用说明，不仅要知道制光圈和快门速度不仅仅是两个单独的功能，还要知道它们如何相互作用，这样就更容易描述每个功能，因为它与其他功能是相互联系的。
2. 
   2
   和专家谈谈。如果你仅仅是手册作者，而不是该领域的专家，那么在整个过程中你需要有相关知识的人，确保他们审查过你的手册。他们的知识和建议是无价的。
3. 
   3
   试着去实践。如果可能的话，尝试着去实践你写的手册，这样至少你能感觉到使用者想要学什么。
4. 
   4
   研读相关资料。学会该领域的术语，对于你介绍的产品也要研究得精通。

   • 从类似产品的手册中，你能看到其他作者是如何解决这个问题的。
     • 寻找各个作者之间的共同点，这些都是在描述物品时常用的方法及功能。
     • 同时也要找到新的点，尽量脱颖而出。这些通常是一个指定物品的独特功能。你的产品可能会有这些功能，也可能没有，或者可能解决问题的替代方法，你可以对这些进行描述，从而提高产品的价值。虽然你的工作是编写一本指南，但如果能向顾客说明他们购买的物品很有价值，能鼓励他们继续往下读这本指南。
   • 浏览贸易杂志。看看使用这些产品的人们平常如何使用它们的。他们可能希望有些特殊问题能得到解决，如果你的产品能解决这些问题，就需要突出强调。
   广告

方法 2

方法 2 的 4:

设计手册的布局

下载PDF文件

1. 
   1
   分成几个部分。无论是一本简单的按步骤进行的指示表，还是一本有关35毫米数码相机的说明书，分成几个部分有一定的好处：

   • 你能专注于整体的各个部分。你的目标是让用户熟悉如何学习整个过程。如果需要的话，如何运行每项功能可以留在最后的个别指导，或者让用户自己去摸索。
2. 
   2
   遵循逻辑顺序。如果你在说明了如何增加镜头、加载影片、打开相机、调整焦点后，再介绍相机的闪光灯如何使用， 效果一点都不好。如果你不了解主题产品，这是非常有用的。
3. 
   3
   用这个作为你的目录模板。
4. 
   4
   检查你的步骤。一旦你确定了各逻辑部分，再回头检查一下确定所有内容都包括了。
5. 
   5
   整理你的物资。应该把你在手册中描述的物品放在手边，并随时准备使用。如果你要做一个纸箱，要准备好纸、剪刀、胶带、胶水和一把尺子。如果你描述一个相机，要确保你的相机是拆开的。如果可能的话，你写的产品在这个时候应该还处于在包装盒里的状态。
   广告

方法 3

方法 3 的 4:

开始编写

下载PDF文件

1. 
   1
   写介绍。介绍为整个手册的定下基调，能让用户大概知道他们接下来要读的是何种类型的手册。是轻松有趣的？还是简单严肃的？这取决于你的读者。教孩子做一个纸箱比教一个医生如何进行心脏手术的语言空间大得多。早点建立起基调，并在全文保持这种基调。
2. 
   2
   在写的每一步的同时，自己动手操作一下。这不仅你的写作更有诚实性和真实感，同时也能保证不落下任何步骤。

   • 如果出于某种原因，不能一步一步操作，也要彻底地将这些步骤想清楚，并向专家咨询。
3. 
   3
   为步骤编号。这能让用户很容易按步骤来操作，如果忘了到什么地方也方便查找。

   • 如果你写在纸上，一定要在每一步之间留下一定的空隙。如果添加了步骤，要记得重新编号。
4. 
   4
   要带上提示和警示信息。当你写作的时候，你可能会意识到，如果用户在进行某一个步骤时不够认真，可能会出现问题。

   • 相反地，如果有一些知识能使用户操作时更容易、更有趣，就把这些知识加进去。
5. 
   5
   对其进行测试。只使用你写的说明来操作描述的物品。如果你发现有些地方缺乏说明信息，就添加必要的信息。重复这个步骤直到所有步骤都完备，在无须添加信息的情况下就可以按你的说明书正确操作。

   • 考虑让一两个朋友使用一下这本手册。当他们学习如何使用产品时，你要认真观察。看他们在哪些地方进展较顺利。看他们在哪些地方迷茫、困惑或失误。听他们要说些什么，然后相应地调整你的手册。
6. 
   6
   校对你的手册。你不想给最后的校对员（是你的公司或你的配偶）交上一本充满了明显错误的手册吧。
   广告

方法 4

方法 4 的 4:

格式

下载PDF文件

1. 
   1
   从最高级开始。所有必要步骤细节完整后，浏览一下手册，找到不同类别的开头。

   • 为它们取一个标题，然后标注其位置。
2. 
   2
   如果适用的话，写一个目录。看看How.com.vn的布局方式。主页提供了许多节头。当你访问某个部分，会列出很多子类以及子类下的文章列表。你的手册越详细，你需要的类别和子类别会越多。（如何吹口哨不需要分类；如何雕刻口哨需要几个类别；以及如何玩笛子需要许多类别和子类别）
3. 
   3
   再次校对。是的，你已经通篇校对了一次。但第二次校对肯定还能发现一些小错误，或者一些不清楚的地方。

   • 对于一本较复杂的手册，你也可以用这次校对的机会检查一下所有的小标题，并使用这些信息来创建一个索引。
4. 
   4
   选择一个标题。
   广告

小提示

• 只要有可能，就解释下你的指令说明！如果你不能插入图片，就举一些常见的例子。例如，在“格式，步骤2”的指令中，看看How.com.vn的布局就可以知道目录该怎么做。
• 即使事情似乎很明显，也要写出步骤！这可以避免给某些不知道这些问题的用户造成麻烦。能增加额外的信息，绝对要比遗漏重要的步骤要好。
• 如果可以的话，让一个新手做一下测试，使用你编写的手册并记下他们的每个问题！这将帮助你补充一些东西，使你的手册更有用。
• 如果你正在编写一个非常详细的分章节的手册，如“如何玩笛子”，第一步可能是列出所有的章节：如“选择一个长笛、组装、并护理；发音、指法、你的第一曲”等等。然后你在写每一章时都要用上编写手册的基本准则，因为每一章本身就像一本单独的手册！
• 在每部分编写在一个单独的纸上（或电脑上），这样更容易编辑。如果有足够空间，并且能找到编辑符号，重新编排就会更容易。在电脑上，在每个步骤之间留出3到4行（按几次“输入”键），这样你可以很容易地找到分段处。

广告