请点击此处以提供帮助 大卫 麦克默里 支付网站托管费用:
捐出你能承担的任何小额款项 !
在线技术写作将继续免费.
在撰写描述时,你可能面临的最大难题是记住该术语在此语境中的含义。我们都使用这个词 描述 宽泛地指代几乎任何讨论或解释。 但在这个语境中,它的意思是 对事物的物理方面的详细讨论. 这意味着讨论诸如颜色, 形状, 尺寸, 重量, 高度, 宽度, 厚度, 质地, 密度, 内容, 构造材料, 等等.
例如,这句话并不真正符合我们对“描述”一词的含义:
计算机软盘是一种用于存储电子数据的设备.
它解释了功能或用途,但几乎没有提供物理细节。然而,这句话无疑是描述:
1980 年代常见的电脑软盘为 3.5 英寸 × 3.5 英寸,厚约 1/8 英寸。
一定要查看一下 示例 描述 可随本章提供。
NotebookLM 生成的本章信息图
用于描述的上下文
如前所述, 描述是技术写作中常见的元素—只是与说明的方式不太相同. 描述更常以一两句话出现在这里, 在那儿以一段出现, 或在别处成为整节内容. 某些类型的技术写作以描述为特色:
- 需要大量描述的事故报告.
- 说明通常需要描述,以便让读者能够想象他们正在做什么以及他们正在使用什么.
描述的内容与组织
以下是对你通常会在描述中找到的各个部分的回顾。 在阅读时,请查看示例描述。
介绍。 仔细规划你描述的引言。确保它完成所有下列适用于你具体描述的事项(但不一定按此顺序):
- 指出将要被描述的具体对象。
- 说明受众为了理解该描述需要具备哪些知识和背景。
- 提供该对象的一般描述。
- 包含对描述内容的概述.
背景。 如果你所描述的事物很可能不为大多数读者所熟悉, 考虑在深入实际描述之前先添加一些背景说明. 如果你打算向非专业人士描述一台 SGO/3 密度计, 你最好先讨论这东西究竟是什么, 它有什么用, 以及它在地球的哪个地区被使用.
对部分或特征的讨论. 你描述的主要部分是对每个部分或特征的讨论. 你必须把你正在描述的事物分成部分, 或特征, 或两者兼有. 部分 很容易: 例如, 一支木制铅笔有铅芯, 木制笔杆, 一个橡皮擦, 和一个金属夹. 特点
一旦你把所要描述的事物划分为各个部分、特征,或两者兼有,下一步就是描述每一项。 对于机械类事物,最好先定义各部件,解释其功能。 之后,你应当按由概括到具体的顺序描述该部件,使用任何合适的描述方式。
注意,在描述中,你可以混合使用其他类型的写作。你会发现在描述时会解释功能、定义术语,并稍微讨论一些过程。 只要主要焦点和大多数内容确实是描述性的,这就不成问题。
关于相关操作或过程的讨论. 在描述的某个阶段,通常在结尾处,总结与你所描述的对象相关的操作或过程是有益的。 例如,如果你刚刚描述了一支自动铅笔,你可以简要说明它如何使用。 如果你刚刚描述了一片雪花,你可以讨论它形成的过程。
描述的来源
|
颜色 高度 宽度 形状 重量 材料 纹理 位置 附着方法 气味 |
深度 数量 图案, 设计 配料 年龄 子部分 长度 完成 温度 水分含量 |

示意图
描述. 请记住这只是关于内容和组织的一种典型或常见模型—还有许多其他可能性.
其他问题
在描述中, 你很可能会为如何处理数字、缩写和符号而感到困惑:
数字. 记住, 技术写作会打破你在过去写作课上辛苦学到的一些规则. 在技术写作的语境中, 我们常常非常关注数字, 并希望它们突出. 这意味着当数字表示精确的、已测量或可测量的数量, 或者表示关键数值时, 你应该在行文中使用阿拉伯数字. 例如, 在这些句子中, 数字的精确性似乎很重要:
杯子的直径是3英寸.
用4个图钉把海报固定在墙上。
然而,这并不意味着要对无关紧要的数值使用数字。例如,在这句话中,报告有多少部分并没有什么令人惊心动魄的:
该报告包含四个主要部分。
请参阅有关 的部分 数字 与 单词 如需了解更多详情.

描述性段落的结构。
缩写。 不 紧跟它们所使用的数字 (例如,将其写成 "8 mm tape" 或 "8-mm tape" 但 不 "8毫米磁带").
符号.
描述中的图形和格式
在大多数描述中, 你至少需要一张你所描述事物的插图, 并在插图上用标注指明各部分. 参见有关 图形 有关创建图形、格式化它们以及将它们纳入您的描述的更多信息。
标题. 在描述中,你应该使用标题和副标题来标出对各个部分或特征的讨论。记住,理想情况下,你应该在单独的段落或部分—并用标题标出该讨论。如果你有背景部分,也要为其使用标题。参见有关章节 标题 针对具体要求.
列表. 列表在描述中远没有在说明中那么重要. 然而, 如果你把部分或子部分逐项列出, 或列出规格, 这些都是适合使用列表的情况. 参见关于 列表 针对特定要求.
特别通知。 在说明中,特殊提示所起的重要作用并不像在操作说明中那样明显。毕竟,如果它真的是一种描述,读者就不应该试图去遵循任何程序,因此不应该有损坏设备、浪费耗材、搞砸流程,或伤害自己或他人的风险。 然而,你可能会发现 注意 特别提示可用于强调重要事项或例外情况。参见关于 特别通知 有关这些特殊通知的正确使用以及它们在指令中的格式和位置的完整讨论.
我很想听听你对本章的想法、反应和批评: 回应—大卫 麦克默里
