请点击这里帮忙 大卫·麦克默里 支付网络托管费用:请捐款任意金额!
Online Technical Writing akan terus percuma.
A 手册, 我们在这里定义的,是以下几个部分的组合:
- konsep maklumat
- 指示 信息
- rujukan maklumat
semua fokus pada satu topik tertentu untuk memenuhi keperluan audien tertentu. Jika anda mengambil kursus penulisan teknikal menggunakan buku ini, projek buku panduan anda 必须 以某种方式包含这三个要素。此外,这些要素应该与您的手册项目自然且合乎逻辑地“契合”。

NotebookLM 生成的图表,关于这一章
Buku Panduan Asas
Concepts. 概念信息解释了事物是如何运作的,事物是如何组合在一起的。对于更复杂的指令,你必须了解一些概念、理论、背景和原则才能执行这些指令。考虑一个软件功能的例子,它使你能够修改或创建自己的颜色。使用像 Photoshop、Illustration、CorelDraw 或 Paint Shop Pro 这样的工具来做这个—实际的按钮和滑动条—是简单的。但是理解色调、强度、亮度、饱和度、密度、对比度、RGB—就很难了。你必须知道计算机色彩理论才能创造出你需要的颜色。
Consider another example: simple Linux file system commands —ls, cd, cp, mv, pwd. To use these commands, you need to understand what files and directories are, and probably what an operating system is as well as wildcards. You really can't understand how to use these commands —follow instructions using them —unless you understand these basic concepts.
Instructions. 如果你理解基本概念,那么你就能聪明地按照步骤逐步进行。指示是那些熟悉的编号列表,仔细引导你完成一个程序。指示无处不在,在产品包装上,在随附电器和电脑的用户指南中。
Rujukan. 最后一类信息涉及查阅信息,或快速参考信息。如果你跟随上面的文件系统示例,你必须先学习文件、目录、通配符的概念。然后你可以跟随并理解关于更改目录、复制、删除或移动文件的指示。不过过了一段时间,你可能不再需要这些指示,但时不时会有一些特殊需求没有在指示部分涵盖,或者你记不住指示中涉及的某些程序。这时你需要基本的参考信息:你只需去那个部分快速查阅。
过了一段时间后,你不再需要概念部分或说明部分:你已经非常熟悉这些程序,甚至可以倒背如流。但偶尔你会忘记一些小细节,或者你有一些特殊任务是你从未做过的 —这时候你就去参考部分。你可能会把概念和说明部分撕掉丢掉。你所需要的只是参考部分。
手册格式与风格
在使用这本书的技术写作课程中,您可能需要遵循关于标题、列表、通知、图形、表格、文档和引言的具体指导方针:
手册原型。 从下面的链接你可以获取一本手册的示范版本。它包含了所有所需的页面,并且格式良好。这个Word文档中包含了段落和字符样式,这将使你的工作更加轻松,并为你的技能增添一些专业素养。
Contents prototype. 目录的原型特别有用:它提供了制作专业外观目录所需的Word样式。要正确设置左对齐和右对齐以及引导点是很困难的:
手册示例
这里有一些手册示例的链接。请注意,这些示例中存在一些问题,我大多数都已做了评论。其中一些也算是边缘手册。对我而言,手册的标准是包含概念讨论、指示和参考信息。
AI 提示为手册
Checklists, which usually go unread, can be used as a source for AI prompts with some changes. Copy the following, paste it into an AI system like Google's Gemini, and see what you might have missed.
Noted: Semua rujukan kepada kandungan, format, gaya techdocs atau komponen-komenya boleh ditemui di dalam 在线技术写作教科书.
马上就来!
I appreciate your thoughts, reactions, and feedback on this chapter: your response—大卫·麦默里.
