跳转到内容

专业和技术写作/修辞/假设

来自维基教科书,开放世界开放书籍

基本假设和潜在问题

[编辑 | 编辑源代码]

在你开始学习一个主题之前,自然会对它做出一些假设。重要的是,除非你能证明这些假设是正确的,否则不要根据它们采取行动。

为工作写作与为学校写作

[编辑 | 编辑源代码]

大多数人对技术写作的主要假设是,它就像为课堂写作一样:你从一个论点开始,完善它,构建结构化的句子,消除第一人称观点,添加引言、主体和结论等等。学校没有教的是,编写备忘录、提案、商务信函和说明与编写学术论文不同。在工作中写作时,你不会逐步阐述你的主要观点——你会立即切入主题。你的老板不会根据你写商务备忘录的水平来给你打分,他们想要的是没有填充物和“废话”的相关信息。

学术界中的“重做”

[编辑 | 编辑源代码]

请记住,当你写备忘录时,可以发送后修改。如果你认为第一次提交没有做好,这给你提供了几乎可以重新提交任何东西的机会。在学校里,这个选项很少提供——一旦你提交了一篇论文,就再也没有“重做”的机会了。你的教授很可能会忽略你的努力。另一方面,你的老板则希望你进行修改。如果你发送了一份关于星期二会议的备忘录,而会议被取消了,如果人们星期二出现在会议上,他们会很生气。在商业中,重新提交很重要,因为商业一直在变化。但是,当你发送你的备忘录初稿时,确保它尽可能接近完美。即使你重做了这份备忘录,人们可能已经打开了它,或者可能还会打开它来查看更改的差异。因此,如果你写了一份新的备忘录说会议不再在星期二举行,这并不一定是一次重做,而是一个全新的备忘录本身。新的主题将是会议取消而不是星期二的会议。但是,如果你重做一份关于进度报告的备忘录,你的老板仍然可能选择阅读你的初稿以及你的第二稿。此外,确保你的第二稿比你的第一稿好。很多人认为,如果这是一份第二稿,它显然会比第一稿好,但这并不总是如此。一定要阅读并重新阅读你的备忘录。

教育与实用性

[编辑 | 编辑源代码]

在学校的时候,你的老师希望你证明你在学习。为了最好地展示这一点,你会准备报告、论文、项目并参加考试。很少有老师会无条件地相信你知道某些东西,而不会要求你证明这一点。这就是为什么在学校写作具有教育目的。你应该把你所知道的写出来,如果你遗漏了什么,你的老师会认为你不知道。

但是,在工作中写东西则完全不同。你的读者是同事和客户,他们对你所写的东西了解得不如你多,他们将你的写作视为指导。这叫做实用写作。因为你的读者试图实现他们自己的实用目标,所以他们希望你的写作清晰、简洁、切中要害。通过只包含必要信息,你帮助你的读者找到他们需要的信息,而不会感到沮丧、无聊或不知所措。

人际关系

[编辑 | 编辑源代码]

在学校写作通常比在公司写作直接得多。当你写论文时,你只有一段沟通关系:你与你的教授之间的关系。由于这是你与作业相关的唯一社交情况,你不会体验到像技术写作那样多种多样的关系。当你查看工作中的写作时,你会意识到你正在与许多不同的人联系。有雇员与雇主之间的关系、供应商与客户之间的关系以及同事之间的关系。你可能经常与其他人竞争,或者你可能在一个项目中与他们一起工作。

图形的使用

[编辑 | 编辑源代码]

技术写作中的图形不仅受到鼓励,而且是强制性的。当你展示某些东西时,一个彩色的图形可能非常具有说服力,特别是如果它能直观地表达你的观点。图形的一些示例是

  1. 表格
  2. 图表
  3. 照片
  4. 图形
  5. 图纸
  6. 符号

图形不仅视觉上具有吸引力,而且使演示文稿易于浏览。通常,它们在学校论文中是不鼓励的。在商业领域,视觉效果可能是获得工作、达成交易或给老板留下深刻印象的决定性因素。但是,在使用图形时,请确保它们是合适的并且与主题相关。向你的员工发送不合适的图形是非常不专业的,如果图形与你的主题无关,可能会造成混淆。图形用于增强文档,而不是减损文档。

团队合作

[编辑 | 编辑源代码]

许多学校开始鼓励小组写作,以了解你将在工作场所体验到的团队合作。办公室里的协作很常见;即使你不是团队成员,你可能仍然会咨询同事和读者。你也可以提交不断修改的草稿。

惯例和文化

[编辑 | 编辑源代码]

你对技术写作的另一个假设可能是它几乎从不改变。但是,如果你将“技术”这个词与“技术”联系起来,你会发现技术总是在不断变化。这就是为什么在你成为一名成功的技术作家之前,你必须了解你的组织的风格以及你的写作的社会和政治因素。

您公司的风格

[编辑 | 编辑源代码]

技术写作不是一个常数。每家公司都有自己的宣传方式,从自由奔放的休闲风格到保守正式的风格。你需要根据公司希望你如何代表它来调整你的写作。

跨文化交流

[编辑 | 编辑源代码]

许多刚开始从事技术写作的人都会有一个主要的假设,那就是他们所在城市的公司的标准就是应该在全世界范围内使用的标准。事实上,这是一个巨大的错误。即使这些假设是无意识的,它们仍然是冒犯性的。Geoff Hart 在他的文章“跨文化交流需要我们检验我们的假设”中谈到了这一点。[1]。他提到,美国人在旅行时会遇到很多明显的陷阱,尤其是当他们身处之前有过类似经历的环境中,但对方是其他美国商人时。动词也会带来问题,还有比喻和短语。复杂句是最麻烦的问题之一 - 当我们使用大词和长句时,最容易被误解。简短明了的写作方式可能看起来不够专业,但请记住,你是在为一个特定受众写作,他们寻找的是熟悉的词语,没有耐心欣赏你对英语的掌握程度。

在为与你习惯的不同的受众写作时,最重要的是要永远不要假设任何事。如果你从另一个角度重新阅读某段文字,并且想,“也许我的受众不会理解这一点”,那么这很可能是真的。技术撰稿人永远不要认为他们的写作不需要编辑。学会编辑自己的写作,就意味着你承认它并不完美。通过这样做,你证明了你正在努力让受众理解你的信息。

潜在的复杂性

[编辑 | 编辑源代码]

如果你选择成为一名技术撰稿人,你将面临许多(潜在的)复杂性。在大多数情况下,这些复杂性与不断变化的世界、不断变化的信仰以及不断变化的文化有关。

技术在技术写作中至关重要,因为许多撰稿人负责创建指南、说明、政策和程序、培训材料等等。随着我们进入数字时代,我们越来越依赖机器来帮助我们,而这些机器的种类每个月都在发生变化。由于技术写作的主要目标之一是预测任何可能出现的疑问或问题,因此对于撰稿人来说,适应不断变化的口味可能非常困难。

道德交流

[编辑 | 编辑源代码]

道德在技术写作中至关重要。通常情况下,工作场所都会存在道德规范(即使它们并不总是被执行,但确实存在)。道德并非非黑即白,许多人可能会对道德规范产生分歧,这可能会使随后的写作变得复杂。

技术编辑的巢穴

[编辑 | 编辑源代码]

技术编辑的巢穴是一个博客,其中有一个专门针对道德的版块,包括如何避免伪造数据、如何选择词语、如何保持客观等等。它非常有用,因为我们所做的大量写作都可能是主观的,而我们自己却没有意识到,因此技术编辑的巢穴有助于寻找红旗。

“道德问题?”作者:M. A. Dyrud

[编辑 | 编辑源代码]

道德问题是另一个关于道德的很有帮助的链接。它特别棒,因为它提供了关于优秀和糟糕的技术写作的例子,解释了委婉语以及不清晰写作和不带偏见写作的危险。

本维基教科书中定义的道德

[编辑 | 编辑源代码]

不用做任何其他事情,你可以查阅本维基教科书其他部分的专业与技术写作/道德部分。它是一个关于如何使用道德实践以及解决不道德实践的好资源。

团队合作

[编辑 | 编辑源代码]

我添加了这一部分,因为许多技术撰稿人在他们的职业生涯中可能会发现自己加入了许多团队,提前了解你将要面对的情况是一个好主意。

你和你的队友可能并不总是同意解决问题的最佳方法。你可能认为自己有最好的想法,但当你发现自己做了所有工作时会感到生气。然而,团队合作共同编辑写作是完成工作最好的方法,因为你不仅在听自己的声音 - 你还在听团队成员的声音,这有助于消除主观性。虽然你可能觉得独自工作效率更高,但这并不总是真的。无论你是否喜欢,你通常会在职业生涯的大部分时间里都在团队中工作,所以尽快适应它。

失去目标焦点

[编辑 | 编辑源代码]

正如你从这篇复杂的维基教科书中可以看出来,你需要记住很多东西才能成为一名成功技术撰稿人。请记住,在技术写作中,你的文字越简洁易懂,效果越好。如果你在一个项目上工作了很长时间,你可能会倾向于偏离主题,但这会严重损害你的最终结果。保持专注,并记住从你的作品中剔除任何一丝观点。一次只关注一个词。

  1. Hart, Geoff. “跨文化交流需要我们检验我们的假设。STC-蒙特利尔,2008 年 9 月 30 日
华夏公益教科书