请点击这里以获取帮助 大卫·麦克默里 为网络托管付款：请捐赠您能给出的任何金额！
在线技术写作将继续免费。
一个 手册在我们这里定义的，是以下几个部分的结合：
- 概念 信息
- 指令 信息
- 参考信息
都集中在特定主题上，以满足特定受众的需求。如果你在使用这本书的技术写作课程中，你的手册项目 必须 以某种形式包含这三种元素。此外，这些元素应与您的手册项目自然、逻辑地“契合”。
NotebookLM生成的本章信息图表
手册基础知识
概念。 概念信息解释了事物是如何运作的，事物是如何组合在一起的。对于更复杂的指令，你必须知道一些概念、理论、背景、原则才能执行这些指令。考虑一个软件功能的例子，它使你能够修改或创建自己的颜色。使用像 Photoshop、Illustration、CorelDraw 或 Paint Shop Pro 这样的工具来完成这个—实际的按钮和滑块—是很简单的。但理解色调、强度、亮度、饱和度、密度、对比度、RGB—就很困难。你必须了解计算机色彩理论才能创建你需要的颜色。
考虑另一个例子：简单的 Linux 文件系统命令 — ls, cd, cp, mv, pwd。要使用这些命令，您需要了解什么是文件和目录，可能还需要了解什么是操作系统以及通配符。您真的无法理解如何使用这些命令 — 按照使用它们的说明 —，除非您理解这些基本概念。
指示。 如果你理解基本概念，那么你就可以智能地按照逐步程序进行操作。说明书就是那些熟悉的编号列表，仔细引导你完成一个过程。说明书无处不在，产品包装上、附带电器和计算机的用户指南中都有。
参考。 最后一个信息类别涉及查阅信息或快速参考信息。如果你遵循了上面的文件系统示例，你首先需要学习和理解文件、目录、通配符的概念。然后你就可以跟随并理解关于更改目录、复制、删除或移动文件的指令。不过过了一段时间后，你不再需要这些指令，但有时你会有一些特殊要求没有在指令部分覆盖，或者你记不住指令部分提到的某些程序。现在是你需要基本参考信息的时候：你只需去那个部分快速查找即可。
于是经过一段时间后，你不再需要概念部分或说明部分：你已经对这些过程习以为常，熟记于心。但时不时你会忘记一些细节，或者遇到一些你从未做过的特殊任务 —这时你就会去参考部分。你可能可以把概念和说明部分撕掉扔掉。你所需要的仅仅是参考部分。
手册格式与风格
在使用本书的技术写作课程中，您可能需要遵循关于使用标题、列表、通知、图形、表格、文档和引言的具体指南：
手册原型。 从下面的链接您可以获得手册的示例版本。它包含所有所需页面，并且格式良好。此Word文档中包含段落和字符样式，这将使您的工作更加轻松，并为您的技能增添一些专业水平。
内容原型。 目录的原型特别有用：它提供了制作专业外观目录所需的Word样式。正确设置左对齐和右对齐以及引导点是很困难的：
手册示例
以下是一些手册示例的链接。请注意，这些示例中存在一些问题，我已对此进行了大部分评论。其中一些几乎可以被视为手册。对我来说，手册的标准是包含概念讨论、说明和参考信息。
手册的人工智能提示
检查表通常不会被阅读，但可以经过一些修改后用作AI提示的来源。将以下内容复制，粘贴到如谷歌的Gemini等AI系统中，看看你可能错过了什么。
注意：有关技术文档或其组成部分的内容、格式、风格的所有引用均可以在其中找到。 在线技术写作教科书.
即将到来！
我很想听听您对这一章的想法、反应和批评： 你的回应—大卫·麦克穆雷.
