如何写一本手册(write a manual)

写一本说明书似乎是一项艰巨的任务,但它比你想象的要容易!这些步骤适用于任何书面指令,从非常简单的(如何鼓掌)到非常复杂的(如何制作半导体)...

第1部分第1部分,共4部分:了解主题

  1. 1这是关键。这似乎不言而喻,但知识是编写成功手册的关键。例如,如果你正在写一本相机手册,知道f-stop和快门速度不仅仅是两个独立的功能,而且知道它们如何相互作用,这将使你更容易描述与整体相关的每个功能。
  2. Image titled Write a Manual Step 1
  3. 2与专家交谈。如果你的角色仅仅是作者而不是主题专家,那么在整个过程中让知识渊博的人参与进来,并确保他们审查你的作品。他们的知识和建议是无价的。
  4. Image titled Write a Manual Step 2
  5. 3.尝试亲身实践的方法。如果可能的话,做你正在写的事情至少会让你感觉到用户想要学习什么。
  6. Image titled Write a Manual Step 3
  7. 4.仔细阅读这个主题。学会谈论话题,熟悉你所写的产品。类似产品的手册将向你展示其他作家如何解决这个问题。寻找作者之间的相似之处,这表明了描述某事物的共同功能和共同方法。寻找突出的差异。这些可能是特定产品特有的功能。您的产品可能包含这些功能,也可能不包含这些功能,或者可能有其他方法来解决您可以描述的问题,从而提高产品的价值。虽然你的工作可能是编写操作指南,但向客户展示他们购买的价值是鼓励他们继续阅读的好方法。吞噬贸易杂志。了解使用这些产品的人每天是如何与他们合作的。他们可能希望有一个功能可以解决他们的特定问题,如果你的产品就是解决方案,那就需要强调一下。
  8. Image titled Write a Manual Step 4

第2部分第2部分,共4部分:规划手动布局

  1. 1拆掉它。无论是一份简单的分步说明书,还是一本35毫米数码相机的手册,将其分解成易于消化的部分都有几个好处:它让你能够专注于整体的各个部分。你的目标是让用户熟悉如何学习这个过程。如果需要,如何执行该功能可以留给最后的教程,也可以留给用户自己去发现。
  2. Image titled Write a Manual Step 5
  3. 2遵循逻辑顺序。例如,在演示如何连接镜头、装入胶卷、打开相机和调整焦距之前,描述相机上的闪光灯是如何工作的是没有用的。如果你对主题不太了解,这一点尤其有用。
  4. Image titled Write a Manual Step 6
  5. 3将其用作目录的模板。
  6. Image titled Write a Manual Step 7
  7. 4回顾你的步骤。一旦定义了逻辑部分,请检查它们以确保涵盖所有内容。
  8. Image titled Write a Manual Step 8
  9. 5收集你的补给。按照手册中的说明,准备好要使用的物品。如果你在做一个纸盒,准备好纸、剪刀、胶带、胶水和尺子。如果你在写关于相机的文章,请确保你的相机已拆解。如果可能的话,你正在写的产品此时应该回到盒子里。
  10. Image titled Write a Manual Step 9

第三部分第三部分,共四部分:开始写作

  1. 1写介绍。这将确定整个手册的基调,并让用户了解他们将要消化哪种手册。它是轻松有趣的,还是直截了当的,毫无意义的?这取决于你的读者群。比起教医生如何进行心脏直视手术,教孩子制作纸盒的语言游戏空间要大得多。尽早确定语气,并在手册中始终保持这种语气。
  2. Image titled Write a Manual Step 10
  3. 2在写作时完成每一步。这不仅让你的写作有一种诚实和真实的氛围,还可以确保没有遗漏任何东西。如果出于某种原因,执行这些步骤不可行,请仔细考虑并咨询专家。
  4. Image titled Write a Manual Step 11
  5. 3.给台阶编号。这使得人们更容易跟随,并在失去位置时返回参考。如果你是在纸上写的,一定要在每一步之间留出空间进行添加。如果添加了更多,请记住重新编号步骤。
  6. Image titled Write a Manual Step 12
  7. 4包括提示和警告。在写作过程中,您可能会意识到,如果用户不小心执行某个步骤,可能会导致问题。相反,如果有一些知识可以让用户的任务更容易或更有趣,那么就把它加入进来。
  8. Image titled Write a Manual Step 13
  9. 5.测试一下。只使用你的书面指示,做你正在写的事情。如果你发现缺少说明的地方,请添加必要的信息。重复这一步,直到你完成了所有的步骤,并且可以完成你正在教的内容,而无需添加注释。考虑让一两个朋友使用手册。当他们学习如何使用产品时,仔细观察他们。看看他们从哪里穿过。看看他们在哪里迷路、困惑或在任务中失败。听他们说什么,然后相应地调整你的手册。
  10. Image titled Write a Manual Step 14
  11. 6.校对你的手册。你不想给你的最终校对员(无论是你的机构还是你的配偶)寄去一本满是明显错误的手册。
  12. Image titled Write a Manual Step 15

第4部分第4部分,共4部分:格式

  1. 1从顶层开始。一旦你有了所有必要的详细步骤,仔细阅读你的手册,找到明显的分类标题。给它们命名,并记下它们的位置。
  2. Image titled Write a Manual Step 16
  3. 2如果适用,写一份目录。以wikiHow的布局为例。主页上有许多版头。当你访问一个部分时,它会列出许多子类别,子类别会列出文章。手册越详细,需要的类别和子类别就越多。(怎么吹口哨不需要,怎么刻口哨需要几个,怎么吹长笛需要很多!)
  4. Image titled Write a Manual Step 17
  5. 请再读一遍。是的,你已经彻底做过一次了。第二次这样做无疑会发现更多的小错误,或者你的手册不清楚的地方。对于更全面的手册,您还可以借此机会记录所有小主题,并使用这些信息创建索引。
  6. Image titled Write a Manual Step 18
  7. 4.选择一个标题。
  8. Image titled Write a Manual Step 19
  • 即使有些事情对你来说很明显,也要写下步骤!它将帮助你避免掩盖用户不知道的东西。最好输入额外的信息,而不是遗漏重要的步骤。
  • 如果你正在写一本需要章节的非常详细的手册,比如如何吹奏长笛,那么你的第一步可能实际上是列出所有章节,比如选择长笛、装配和保养、音调制作、指法、你的第一件作品等等。然后你会将编写手册的基本规则应用于每一章,因为每一章本身就像一本单独的手册!
  • 只要有可能,请说明您的说明!如果你不能插入图片,请让你的学生参考一些常见的例子。例如,在这些说明的格式化步骤2中,wikiHow的布局外观用于说明如何创建目录。
  • 在单独的页面(或在计算机上)上编写每个部分将使编辑更容易。如果你有工作空间并且能找到你的编辑标记,你可以更容易地重新安排。在电脑上,在每一步之间留出3到4行(按几次回车键),这样你就可以很容易地找到断点。
  • 如果可以的话,让一个新手对你的手册进行测试,并记下他们提出的每一个问题!这将帮助你填空,使你的手册更有用。
  • 发表于 2022-05-10 15:53
  • 阅读 ( 12 )
  • 分类:教育

你可能感兴趣的文章

如何写一本书(write a book)

...好的建设。归根结底,一本好书应该很难让读者放下。 如何开始写书 如何开始写你的书?在写作之前,试着给自己买一个漂亮的小笔记本,这样你就可以随时随地把你的想法写下来。然后,把这个故事写在你的笔记本上,然后...

  • 发布于 2021-06-27 00:54
  • 阅读 ( 182 )

手册(manual)和指导(guide)的区别

...信息让用户开始使用。因此,指南将不包括关于每件事情如何工作的信息,而只是用户需要做些什么才能让它工作。然而,一本手册将详细说明如何和为什么一切工作。它将有如此多的细节,用户可以了解系统,甚至可能是要排...

  • 发布于 2021-07-12 11:42
  • 阅读 ( 241 )

如何我写金融论文?(i write a finance thesis?)

金融论文是学生在金融课程上提交的冗长书面文件,作为其评估的一部分。在某些课...

  • 发布于 2022-02-06 23:49
  • 阅读 ( 149 )

什么是一本会计手册?(an accounting manual?)

... 商业组织通常会制定一本会计手册,其中规定了公司账户的所有会计政策、准则、程序和标准。 会计手册中包括账户分类、应遵循的会计规则大纲以及该组织的具体规则。 根据商业实体的类...

  • 发布于 2022-02-08 15:58
  • 阅读 ( 134 )

如何我选择最好的咖啡师手册?(i choose the best barista manual?)

...本好的咖啡师手册后,你应该知道冲泡特浓咖啡的过程,如何选择优质的特浓咖啡烘焙,如何拉动镜头,并知道定量、调平和捣实这些术语的含义。 ...

  • 发布于 2022-02-12 23:31
  • 阅读 ( 108 )

如何创建用户手册(create a user manual)

...和可连接部件。 4包括安装说明。设置部分应包括有关如何准备使用产品或设备的基本信息。如果家庭用户无法构建或设置设备,请在设置部分顶部的粗体标题中明确说明这一事实。您还应该包括:零件清单拆包说明与设置相...

  • 发布于 2022-03-20 06:43
  • 阅读 ( 102 )
iO1fpX0HDS
iO1fpX0HDS

0 篇文章

相关推荐