耐用性和清晰度的十大秘诀

撰写行业标准是我职业生涯中经常做的一件事。 我是航空业几个委员会的一部分,这些委员会负责创建文件,这些文件经过广泛的共识和审查过程,通常被世界各地的政府机构接受为遵守各部分的可接受方式他们的法规。 (我也参与了其中一些法规的重写)。 就我个人而言,我真的很喜欢这种工作,尽管许多同事认为我的工作可能会有些困难。 对我来说,这是一个令人着迷的难题-如何使用英语写出您的实际意思,以使您从未遇到过的人可以从现在开始的1.5年,10年后阅读这些单词,并确切地知道您所拥有的头脑:不多也不少。 由于这不是这种交流非常重要的唯一上下文,并且与人们必须做的许多其他写作有很大不同,因此这里有十个技巧,可以使您的意思持久清晰(并且很持久) :

  1. 使用必须,应该,可以和适当的朋友。
    细节决定成败。 在日常交流中,诸如“可能”,“必须”,“应该”,“应该”,“可以”和“可能”之类的词可以相对互换使用。 在编写法规或标准时,这些词的含义截然不同。 “必须”和“必须”表示一个指令:“所有飞机必须涂成蓝色”或“您应该将飞机涂成蓝色”不同于“所有飞机都应涂成蓝色[但也可以涂成绿色]”或“您可以将飞机涂成蓝色(或绿色,品红色或橙色)”。 如果可以接受使用“必须”或“必须”以外的内容,请仔细考虑是否需要该陈述。 您在文档中输入的内容很可能最终会作为责任审判的一部分,或者至少会影响认证和合规成本,因此不欢迎您提出主动性建议。
  2. 适当使用例如,等等。
    如果使用不当,可能会引起恶性反应的另一个细节是我们在日常写作中都会用到的这些小缩写。 要记住的最大区别是“即”和“例如”的含义非常不同。 如果使用“ ie。”,则表示以下是唯一可接受的替代解释或示例。 如果使用“ eg”,则表示以下是示例,但不是详尽列表。 在列表末尾加上“等”表示您可能应该以“例如”开始并完成它。 不要在相同的列表中使用“ eg”和“ etc.”,因为这是多余的。 并且不要在同一列表中使用“ ie”和“ etc.”,因为这是矛盾的。
  3. 使用牛津逗号。
    战争是在引起比牛津逗号更少热情的问题上进行的。 无论您在个人生活中选择做什么,我都会在这里告诉您,如果您想写清楚一些,则需要使用牛津逗号。 对于那些不熟悉牛津逗号(也称为系列或系列逗号)传奇的人,列表中“ and”之前的逗号是:“测试必须使用水,沙子和盐雾进行”表示您正在进行三项测试; “测试必须使用水,沙子和盐雾来完成”意味着您要进行两次-并且最后一个测试将与第一个示例中的三个测试完全不同。
  4. 每个单词使用一个意思,每个意思使用一个单词。
    这是另一个领域,您个人对写作风格的偏爱必须优先考虑,以求明晰。 我们经常在中学英语课上教我们改变措辞,而不仅仅是一直使用相同的词。 乔离开家时,他可能会走路一次,但下一次他可能会漫步,闲逛,跳过或洗牌。 在标准和规范性写作中,每个单词每次使用时都必须始终具有相同的含义,而且更阴险的是,每次您表示相同的事物时都必须使用相同的单词。 没有创造力的要点。 因此,为给定的含义选择最清晰,最合适的词,并坚持下去。 每次乔离开房子时,除非有故意和有价值的理由来表达它不同,否则他只是走出门。
  5. 使其可实现并注意隐含的公差。
    使用“最小化”或“最大化”之类的词很诱人,但实际上并不意味着任何具体含义。 从技术上讲,最小化或最大化某些事物是一个永无止境的过程。 从理论上讲,无论增量更改是否对需求的根本意图产生明显影响,它的总和都可能多少有些不同。 如果您想使用这些开放性词语中的一个,请问自己是什么,这使您无法设定清晰的“足够好”的水平:您是否需要研究或行业经验来得出数字? 还是可以用更明确的方式重新表达您的担忧? 通过指定可能的解决方案来解决这个问题很诱人,但是最好看一下第6项,并继续研究表达需求意图的替代方法。 如果要包括数字,请注意,添加额外的有效数字(例如,更多非零数字:3000与3145)会增加尝试使用正在编写的文档的人员的成本。 如果不必精确到十分之一英寸(或四分之一磅),则不要以该精确度级别指定数字。 当涉及单位转换时,请特别注意这个陷阱:从标准起草的角度来看,5磅等于2千克。
  6. 将意图与实施分开。
    这一点超出了语义,而变成了标准和法规写作的哲学。 通常,根据您期望的应用方式来考虑需求或标准文档中应包含的内容通常会更容易。 在探索和起草阶段,此思想过程没有错,但是在措辞最终确定之前,您需要问自己是否真正需要的是基本意图或对可能满足的特定解决方案的要求这种意图,但可能不是实现预期目标的唯一可能方法。 例如,您可以指定汤“必须用木勺每两分钟搅拌一次”,或者您可以指定汤“必须均匀加热,同时防止其粘在盛有汤的容器底部”以不会永久标记或以其他方式损坏所述容器的方式加热”。 第一个示例似乎更简单,但是它强加了各种意想不到的要求,这些要求可能会替代其他但完全可以接受的午餐方法。 硅胶刮刀怎么样? 旋转整个事情怎么样? 来自化学实验室的那些漂亮的磁性自动搅拌豆怎么办? 要求,标准或法规的重点是确保满足最低意图,而不是指定某人必须如何达到该意图。 这对于使使用文档的人员创新和管理成本是必要的。 通过将文档与当前的最新技术分开,还可以延长文档的使用寿命。 如果您坚持实施,这将有助于询问“您为什么要这样做?”。
  7. 谨慎使用“批准”,“适当”或“可接受”等。
    暗示来自所讨论文档范围之外的实体的赞许之词带有很多负担,并且可能会非常繁重。 如果需要使用这些单词之一,请非常明确地使用。 以下问题可能有助于更清楚地定义情况:谁在进行批准? 您是否可以使用“ XYZ文档的最新发布修订版”之类的短语? 是什么使某件事合适/不可接受? 造成歧义的根本原因是什么,促使您要移交设定需求的责任,并且有什么方法可以改写以明确要点? 这些词确实成为标准,法规和其他要求文档,有时它们是不可避免的,但在起草过程中应将其视为危险信号。
  8. 关注最小可接受的内容。
    这与#5紧密相关,但是增加了-或通常是删除了-一层。 也许以我们的汤为例,它不必均匀加热,但在送达之前必须将其全部加热到温暖但又不太热的温度。 因此,最好指定汤的任何部分的最高温度,然后再将其煮熟。 市场力量可能会驱使准备汤的人确保其产品均匀加热,不结块,否则会美味。 作为监管者或标准制定者,这实际上不取决于您-从安全的角度来看,防止汤锅被烫伤是最低限度可接受的要求。 这种思维驱使真正的需求与真正的需求分离开来,并且可以在是否满足要求或是否视其为混杂而略微的要求之间产生差异。
  9. 考虑所有利益相关者的成本和收益。
    精通标准的,精益求精,专注于安全意图的精益标准经常受到行业欢迎。 清晰,干净的标准描述了在不规定最低标准的情况下可接受的最低要求,从而为制造商提供了一定程度的责任保护,而又不会过度提高成本或阻碍创新。 (“指南”或“最佳实践”文档中经常包含“如何”的内容,它们在不暗示要求的情况下也非常有用。)最终形成标准或法规文档的所有内容最终都会对文档的处理方式产生重大的长期影响。行业的发展:由撰写这些内容的人员来思考这些潜在影响以及与之相关的成本/收益贸易。 这种思考过程的一部分应该是施加可能阻止新技术推向市场的要求的潜在成本和/或风险:如果提出了无法达到的要求,那么消费者会因为重要的安全或其他利益而错过吗? ?
  10. 少即是多。
    如果可以将其取出,请执行。 这些类型的文档在其生命周期中往往会大量耗水,因为随着时间的流逝,它们通常会有机地变得更加复杂,但是很少经历戏剧化的简化。 因此,由于标准,法规或要求中包含的所有内容最终都将导致成本上升并在某个时候对某人施加限制,因此,如果不能完全确定应该包含某个特定点,则将其遗漏。 另外,要用言语有效。 口语,行话,旨在使某些内容更具可读性的表达方式以及一般的细节都在路上。 被动的声音也不是您的朋友。 制作简单,直接,无歧义的句子,使用最少的单词数。

最初在 www.annamdietrich.com上 发布