请点击这里以获得帮助 大卫·麦克默里 支付网络托管费用:
捐赠您能的小额款项!
在线技术写作将保持免费。

在撰写描述时,您可能面临的最大障碍是记住该术语在此上下文中的含义。我们都使用这个词 描述 松散地指代几乎任何讨论或解释。但在这个上下文中,它的意思是 事物物理方面的详细讨论这意味着讨论诸如颜色、形状、大小、重量、身高、宽度、厚度、纹理、密度、内容、构造材料等等。

例如,这句话在我们理解的意义上并不是真正的描述:

计算机软盘是用于存储电子数据的设备。

它解释了功能或目的,但几乎没有或没有物理细节。然而,这句话绝对是描述性的:

1980年代常见的计算机软盘尺寸为3.5英寸 x 3.5英寸,厚度约为1/8英寸。
Diskette

软盘:过去的遗物

确保查看一下 示例描述 本章节提供。

NotebookLM-generated infographic of this chapter NotebookLM生成的本章信息图表

描述的上下文

如前所述,描述是在技术写作中常见的元素,只是在表现方式上与指令略有不同。描述往往以一句或两句、一个段落或在其他地方的整个部分出现。某些类型的技术写作以描述为特色:

内容和描述的组织

以下是您常见的描述部分的评论。在阅读时,请查看示例描述。

介绍。 仔细规划你的描述的引言。确保它完成所有以下事项(但不一定按此顺序),适用于你的特定描述:

背景。 如果您所描述的事物可能对大多数读者不太熟悉,可以考虑在实际描述之前添加一些背景知识。如果您要向非专业人士描述SGO/3密度计,最好先讨论一下这个东西到底是什么,它的功能是什么,以及它在地球上的哪个地方被使用。

部分或特征的讨论。 您描述的主要部分是对每个部分或特征的讨论。您必须将您所描述的事物分为部分、特征或两者。 零件 很简单:例如,一支木制铅笔有铅芯,一个木桶,一个橡皮擦和一个金属夹子。 特征 是可以描述的事物方面,但不是部分:例如,铅笔有一定的重量、长度、宽度等。如果你是一位初出茅庐的房地产大亨,需要为公司档案描述一块空地,你可能会通过它的特征来描述它:位置、平方英尺数、地形、植被、公共设施接入等。(查看示例中原始石刮刀的描述;其中一部分是按特征排列的,另一部分是按部分排列的!)

Pencil

一旦你将要描述的事物分成部分、特征或两者的结合,你的下一个任务就是描述每一个部分。对于机械物品,首先定义这个部分,解释它的功能是很有效的。之后,从一般到具体描述这个部分,使用适当的描述来源。

请注意,在描述中,您可以混合其他类型的写作。您会发现自己在描述时解释功能、定义术语、讨论一些过程。这没有问题,只要主要焦点和大部分内容确实是描述。

相关操作或过程的讨论。 在描述的某个阶段,通常在结尾时,总结与所描述对象相关的操作或过程是很有用的。例如,如果你刚刚描述了一支机械铅笔,你可以简要说明它的使用方法。如果你刚刚描述了一片雪花,你可以讨论它形成的过程。

描述的来源

当你写描述时,需要考虑你可以提供哪些类型的描述性细节。有时,描述在这一方面相对较弱。使用以下列表来计划你的描述或回顾你写的描述。考虑你可以提供的描述性细节类别,或者使用以下列表识别你未使用的类别:

颜色
高度
宽度
形状
体重
材料
纹理
位置
附件方法
气味
深度
金额
图案,设计
成分
年龄
子部分
长度
完成
温度
湿度含量

Schematic view of
descriptions
描述的示意图。 请记住,这只是内容和组织的一个典型或常见模型,许多其他模型也是可能的。

杂项问题

在描述中,您可能会发现自己对如何处理数字、缩略语和符号感到困惑:

数字。 请记住,技术写作打破了您在过去的写作课程中努力学习的一些规则。在技术写作的背景下,我们通常非常关注数字,并希望它们突出显示。这意味着当数字表示确切、测量或可测量的数量,或当它代表一个关键值时,您应该在运行文本中使用数字。例如,在这些句子中,数字的准确性似乎很重要:

杯子的直径是3英寸。

用4个钉子把海报固定在墙上。

然而,这并不意味着对无关紧要的数值使用数字。例如,在这句话中,报告有多少个部分并没有什么令人心跳加速的地方:

报告包含四个主要部分。

请查看部分内容关于 数字 vs. 文字 以获取更多详细信息。

Anatomy of a 
descriptive paragraph
描述性段落的结构。 通常,它以某个关于部分的目的或功能的陈述开始,接着是描述细节。描述细节基于"来源"的描述—诸如颜色、形状、宽度和高度等内容。

缩写。 在技术写作中,我们期待看到缩写。可以在描述中自由使用它们。记住关于缩写的标点规则—只有在它们拼写出一个单词时才需要标点(例如,"in.")。还要记住,缩写确实 与它们所使用的数字对抗(例如,制作 "8 毫米磁带" 或 "8 毫米磁带" 但 "8毫米胶带").

符号。 在说明和描述中,最常见的问题与英寸和英尺有关。如果你在为木匠的梦想项目编写说明,项目中到处都是英尺和英寸,请使用符号“"”(英寸)和“'”(英尺)。但是,如果你只在少数几次中提到英寸和英尺的测量,则改用单词或缩写。

描述中的图形和格式

在大多数描述中,您需要至少一个您所描述事物的插图,并带有指向各个部分的标签。请参见章节关于 图形 有关创建图形、格式化它们以及将它们融入您的描述中的更多信息。

标题。 在描述中,你需要使用标题和副标题来标明对各个部分或特征的讨论。请记住,理想情况下,你希望在单独的段落或部分中描述每个部分,并用标题标记该讨论。如果你有背景部分,也请为其使用标题。请参见该部分。 标题 针对具体要求。

列表。 在描述中,列表并不如在指令中那么重要。然而,如果你列出部分或子部分或列出规格,这些都是适合使用列表的好情况。请参见相关部分。 列表 特定要求。

特别通知。 在描述中,特別注意事项并不像在说明中那样重要。毕竟,如果它真的只是描述,读者就不应该试图遵循任何程序,因此也不应该有损坏设备、浪费耗材、搞砸程序或伤害自己或他人的风险。然而,您可能会发现 笔记 特别通知,以强调重要点或例外。请参阅有关章节。 特别通知 有关这些特殊通知的正当使用、格式及其在说明中的位置的完整讨论。


我希望您能分享对这一章的看法、反应和批评: 回复大卫·麦克默里