如何创建用户手册

消息 发布 标签 来源 关于我们 隐私
GratisForGratis

WikiHow

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

用户手册是物理书面指南（纸质）或电子文档（PDF 或 XPS），提供有关如何操作或使用某些内容的说明。尽管“用户指南”通常被认为与计算机软件相关，但用户手册也附在计算机或其他电子设备上，例如电视、音响、电话和 MP3 播放器，以及家用电器和花园设备。一份好的用户手册可以让用户了解产品的功能，并以有效且易于理解的方式教授他们各自的操作。以下是创建有效的用户手册内容和布局时要考虑的元素。
部分 1
第 1 部分（共 3 部分）：

创建用户友好的文档

下载PDF
  1. Step 1 Definisci l’utente di riferimento.
    要编写成功的手册，您需要对用户进行概要分析，无论是正式的（通过创建书面配置文件）还是非正式的（通过花时间对用户的特征做出合理的假设）。当您是编写用户文档的团队的一员时，这样的配置文件非常有用，并且在将产品从想法转变为最终形式的过程中也很有帮助。编写用户个人资料时，要考虑的要素包括：
    • 用户将在家里、办公室、远程工作场所或汽车中使用本手册。这不仅会影响手册的内容，还会影响手册的风格。
    • 用户将如何使用该指南。如果很少需要查阅手册或搜索信息，则应主要采用参考文件的形式。如果用户最初经常查阅该内容，则参考部分应附有“入门”部分和有关产品最常见用途的说明。
    • 用户对该产品或同一类别的其他产品已有多少经验。如果您的产品是新产品或与类似产品有很大差异，您将需要对这些差异进行解释，以及如何开始使用它的说明。如果产品解决了用户经常遇到的问题，例如许多计算机应用程序，您将需要以易于理解的方式提供足够的信息和详细信息。
  2. Step 2 Rivolgiti ai bisogni del tuo utente in modo che questi possa capire.
    除非用户具有技术经验，否则最好避免使用特定术语，而更喜欢清晰简单的解释。文本的组织方式还应适应用户的推理；通过按功能分组来列出产品功能通常比列表中更常用的顺序更有意义。
    • 有时无法绕过技术术语，例如图表软件包含斐波那契图表以及更常见的饼图和条形图。在类似的情况下，定义该术语并提供解释是有用的，例如通过深入研究斐波那契表在金融分析中的定义和用途。
  3. Step 3 Spiega il problema che l’utente sta cercando di risolvere, poi presentane la soluzione.
    在产品的销售阶段，只提供通用问题的解决方案是有效的，但一旦用户购买了它，他就必须了解如何以最佳方式使用它。确定用户将遇到的具体问题，在用户指南中说明这些问题，然后继续解决这些问题的说明。
    • 如果问题很复杂，请将其分解为更小的部分。将每个部分列出并附上如何解决或处理的说明，然后依次排列。这个过程被称为“分块”。
    广告
部分 2
第 2 部分（共 3 部分）：

用户手册的要素

下载PDF
  1. Step 1 Includi la copertina e i frontespizi appropriati.
    每份用户指南都需要一个封面，其中不仅仅包含参考卡，还需要比折叠纸更长的手册封面页（4 页或更多页长）。
    • 如果手册受版权保护，则必须在封面和扉页上注明。
    • 如果您需要报告使用手册和相关产品的条款和条件，则必须将其包含在封面内侧。
  2. Step 2 Inserisci riferimenti ai documenti collegati nell’introduzione.
    如果用户文档涵盖多卷，请在此处提供对其他文档的引用以及正确的版本。如有必要，在介绍部分还可以插入“如何使用本指南”部分。
  3. Step 3 Includi un indice, in caso il manuale superi le 10 pagine.
  4. Step 4 Metti le istruzioni/metodi e i materiali di riferimento nel corpo centrale del manuale.
    在许多情况下，方法和参考材料都应该有自己的部分，尽管您始终可以告诉用户从一个部分到另一部分引用特定内容。这样，用户可以更快地找到他们正在寻找的信息。
    • 方法应在手册的整个说明部分中保持一致。从任务概述开始，然后描述用户需要做什么以及他应该实现什么结果。这些步骤应该编号并以动作动词开头，本文每个部分中的步骤也应该如此。
    • 参考材料可能包括选项列表、提示和常见问题。尽管常用术语列表可能出现在手册的开头，但术语表和附录可能会添加到手册的末尾。如果手册少于 20 页，则可以省略索引。
  5. Step 5 Usa delle grafiche qualora sia necessario sostenere il testo.
    图形或屏幕截图比文本更能说明手册中的某些要点，尤其是在用户需要视觉确认正确执行的复杂程序中。图形可以使用 CAD 程序或图形软件、数字编辑和数码相机来生成，或者在屏幕截图的情况下，通过计算机的内置功能（“stamp”/cmd+shift+3）或提供以下功能的图形程序来生成：屏幕录制选项。
    • 创建图形后，将其保存为压缩格式，以便在编写或发布程序时使用它们。您还需要减小文件大小，以便更容易包含在页面上，而不减少用户的详细信息（如有必要，您可能需要分解原始图像并在浏览文本时显示相关部分） 。
    • 如果您在方法中使用大量图形，请保持尺寸的一致性，无论它们的长度和宽度都相同，还是始终从原始尺寸缩小到相同的比例。这将使图像对用户更具吸引力。同样，将屏幕截图保存到计算机时，请确保在此步骤中将计算机设置为标准颜色，以防手册要求您保留这些颜色。
    • 虽然 Photoshop 和 Paint Shop Pro 等图形程序提供了良好的屏幕保存功能，但 SnagIt 等专业程序还允许您轻松编辑、编目和固定屏幕。
    广告
部分 3
第 3 部分（共 3 部分）：

设计一本可读的手册

下载PDF
  1. Step 1 Scegli un paio di font leggibili.
    尽管计算机可以支持许多不同的字体，但用户手册的目标是易于阅读。选择一些匹配的字体是实现这一目标的最佳方法。字体有 2 类：“衬线”和“无衬线”（带或不带衬线）。
    • 衬线字体在字母主笔划的末端有小的终止点。Serif 字体包括 Times New Roman、Baskerville 和 Book Antiqua。衬线在印刷用户手册正文中的 10-12 尺寸大文本块中效果最佳。
    • 无衬线字体仅显示形成字母的笔画，没有结尾。无衬线字体包括 Arial、Calibri 和 Century Gothic。这些字体可用于在线手册或 PDF 中的大块 8-10 文本，但缺少结尾会使 12+ 大小的句子更难以阅读。然而，它们可以在较大尺寸下有效地用于显示标题和标题，并且同样适合在较小尺寸下显示页脚和列或表中的数字。
    • 您通常应该为您的用户手册选择中性字体，例如 Arial 或 Times New Roman，但如果您正在为带有幻想或科学的视频游戏撰写文章，则在引用或标题的情况下最好选择装饰字体小说设置（如果是同一文本的摘录，您通常可以使用相同的字体，即“斜体”格式）。
    • 选择要使用的字体后，创建一个测试页来检查这些字体在纸上看起来是否很好。您可能还想向需要在继续操作之前批准手册外观的任何人出示此证明。
  2. Step 2 Pensa all’impaginazione.
    一旦为用户手册选择了字体，您就需要决定页面各个元素的位置。
    • 通常，您需要将手册或章节标题放在页眉或页面底部，最好使用左侧页面的手册标题和右侧页面的章节标题。页码应位于上方或下方、向外（页眉或页脚）或居中（仅页脚）。您可能希望将每个部分或章节的首页与其他页面区分开来，方法是将其页码放置在页眉的中心，并将后续页码放置在页眉的外角。
    • 您可能想要在彩色或阴影框中绘制部分文本，以将它们与文本的其余部分分开。确保选择不与文本重叠的颜色或阴影程度。
    • 在所有边上留出相当宽的边距，并在将装订在一起的边缘上留有足够的空间。
  3. Step 3 Considera il tipo di rilegatura del manuale d’uso.
    如果您的手册超过 4 页，则需要以某种方式装订。虽然内部文档可以在一角装订在一起，但随产品提供的外部手册通常采用以下 3 种方式之一装订：
    • 侧订书钉适用于尺寸为 21x27.5 厘米、21x35 厘米或 27.5x42.5 厘米的折叠纸制成的手册。大多数48页以下的经济手册都是这样装订的。
    • 侧缝更常用于外部参考指南，而不是非汽车产品附带的用户手册，尽管一些较长的指南以这种方式装订（Paint Shop Pro 最初附带缝线装订指南，由 JASC Software 制作） ）。
    • 螺旋装订适用于设计得更坚固的用户指南，例如户外环境，在这种环境中，装订或装订手册将无法抵抗。一些螺旋装订手册还可能包含层压页，以防止它们因接触水或泥土而损坏。
  4. Step 4 Costruisci un modello per il tuo manuale.
    许多写作和出版程序都提供了为用户手册创建模板文档的可能性，这样当您编写时，文本会自动以所需的字体出现在您正在处理的手册部分中（事实上，这篇文章是最初使用 MS Word 模板编写）。其中许多程序还包含一组预制模板，您可以修改它们以满足您的需求，而不是从头开始创建模板。
    • 编写和发布程序还允许您创建“样式”、页眉、页脚、标题和文本正文的预设字体和大小。您可以选择一种预定义样式（例如“Heading1”、“Normal”、“Quote”）或使用自己的名称创建自己的自定义样式。如果同一段文本有多种样式（例如，MS Word 将标题样式标记为“标题 1”、“标题 2”等），请尽可能遵循机构样式命名约定。按标题，从主标题到各个副标题级别）。尝试提前创建您需要的所有样式，这样您就不必在实际写作过程中停止创建它们。
    广告

建议

  • 尽可能充分利用代码和文本变量。您可以为其分配值，例如产品名称、手册或章节的标题，并将它们放置在文档中，而不是编写实际的文本。当您预览或打印文档时，文本将替换变量。如果产品名称发生变化，或者更改手册或章节的名称，通过替换文本变量的值来更改信息会比在文档中搜索并替换它更容易。
广告

你需要的东西

  • 编写或发布程序
  • 图形或视觉记录程序
已获得许可: CC-BY-SA
CAPTCHA

发现网站：siteUrl

广告

 

^