跳转到内容

专业与技术写作/基础/修订

来自Wikibooks,开放世界中的开放书籍

修订和编辑文档

[编辑 | 编辑源代码]

为什么要修订?

[编辑 | 编辑源代码]

修订是任何语境下写作过程中一个重要的方面。无论你在起草阶段多么遵循以读者为中心的原则,在修订过程中总能进行改进。

修订对于成为一名成功的作者至关重要。在写作时,最有影响力的作者知道在起草用于沟通的文档时,遵循以读者为中心的原则非常重要,尤其是在常见的职场环境中。修订文档可以提高文档的可用性和说服力。但是,必须注意修订文档包括什么,因为它是在开发成功文档的过程中非常重要的一个过程。修订文档需要特定的程序和策略。

修订与编辑

[编辑 | 编辑源代码]

编辑是指对文档进行表面上的更改或重新排列现有内容的过程。相比之下,修订是指对文档进行重大更改的过程,例如添加新文本或整个部分。在修订过程中,你可以改变呈现材料的方式。与编辑相比,修订更加耗时,因为它涉及更多的批判性思维,而不仅仅是常识。 --Nardi82 (讨论) 2010年4月30日 (UTC) 19:22


编辑示例

  • 更正拼写错误的单词
  • 改写含糊不清的句子
  • 添加逗号、句号等


修订示例

  • 修改论点陈述
  • 添加包含支持性证据的部分
  • 添加图形以使主题更容易理解
  • 删除冗余或离题的段落


将编辑和修订视为两个独立的主题是有用的,尽管它们有时会同时进行。作者很容易跑题,并在编辑过程中修订草稿的一部分。这并不一定是坏事,但你必须记住,然后编辑你刚刚创建的新部分。否则,很容易在编辑过程中意外地跳过某个部分。

修订自己的草稿

[编辑 | 编辑源代码]

在修订自己的草稿时,需要考虑五条指导原则

1. 从读者的角度检查。不要关注标点符号、语法或拼写,而是专注于你的目标。你希望读者在阅读你的草稿时想到什么?你希望他们有什么感受?在确定你的目标后,慢慢阅读你的草稿,同时考虑读者对你草稿的反应可能是什么。你的读者可能会更改哪些内容?你的草稿是否具有说服力?你的目标是否明确?信息对你的读者是否有帮助?考虑所有这些问题。试着像第一次阅读一样阅读它。即使没有先前的背景信息,它对你来说仍然有意义吗?假设你是一个十岁的孩子:它是否用了一种十岁的孩子都能理解的简单语言?

2. 从雇主的角度检查。当你处于工作环境中时,你应该考虑你的雇主可能会如何看待你的文档。你应该问自己的问题是

  • 它会引起组织内部的任何冲突吗?
  • 我是否代表组织做出承诺?
  • 我是否遵守组织内的政策?
  • 我是否回答了提出的问题?
  • 我的解决方案是否符合伦理?
  • 我的解决方案是否只会以积极的方式代表公司?

3. 与你的草稿保持距离。在你重新阅读文档之前,给自己一些时间。第二天再读一遍,看看你用新鲜的眼光感觉如何。大声朗读文档。这将帮助你找到没有意义的部分。当你难以理解一个句子时,通常意味着它没有流畅地表达。如果对你来说没有意义,对你的读者也没有意义。

4. 多次阅读你的草稿,每次都改变你的关注点。至少阅读两次你的文档,一次关注说服力和意义,另一次关注机械方面。一次专注于一件事将帮助你更好地修订文档。但是,在创建有意义的文档时,修订是关键。只重新阅读两次是不够的。没有所谓的完美无缺,但你可以让你的文档对你来说完美无缺。

5. 利用计算机辅助工具来帮助检测问题。有许多计算机程序提供某种形式的辅助工具来帮助你检查草稿。这些辅助工具包括:拼写、语法和风格检查器。它们可以帮助你关注文档中可能存在的错误。如果语法或风格检查器标记了你认为正确的内容,请在线查看规则,看看是否真的存在错误,或者计算机是否出错。

编辑或修订草稿时需要考虑的一些问题

[编辑 | 编辑源代码]

在你修订和编辑草稿时,务必牢记几个关键问题。如果你在通读草稿时牢记这些问题,你更有可能发现问题并进行修复,从而使文档更易于使用。


1. 你的读者通过阅读你的文档将获得什么?

  • 如果你牢记读者在阅读你的文档时在寻找什么,你就可以专注于这些要点,并比不太相关的的信息更强调它们。如果你发现某些信息对你的受众不重要,那么就不要包含它。

2. 你的读者所在的组织将如何从这份文档中受益?

  • 类似于专注于读者的利益,专注于整个组织的利益将有助于你强调对组织目标和成功至关重要的信息。

3. 你在整个文档中使用了合适的语气吗?

  • 在整篇论文中保持一致的语气非常重要。选择适合你和你读者专业知识和职位水平的语气,并坚持下去。在通读文档时,确保你的语气没有发生任何变化,因为如果发生变化,会让你听起来不专业或自命不凡。

4. 你是否在写作中使用了主动语态并避免了被动语态?

  • 在你的沟通中使用主动语态将有助于你在句子中将主语和动作执行者放在一起。这样做不仅听起来更好,表达更流畅,而且还可以让句子中执行主语的动作执行者获得相应的荣誉。请考虑以下示例


写得不好的句子:公司网站的更新将由我们的首席计算机技术人员进行。

写得好的句子:我们的首席计算机技术人员将进行公司网站的更新。


  • 请注意,在第一个句子中,主语更新公司网站动作执行者首席技术人员之前被提及。第二个句子通过首先告诉读者谁将执行句子中的主语来纠正了这一点。

5. 你是否将相关词语放在一起以避免混淆?

  • 始终注意将相关词语分开的句子,因为这可能会让读者感到困惑。通过仔细阅读草稿,你应该能够发现这些问题。请考虑以下示例


写得不好的句子:垫圈用于将两块木头螺栓连接在一起,它们是环形金属片。

写得好的句子:垫圈,它们是环形金属片,用于将两块木头螺栓连接在一起。


  • 请注意,第二个句子清楚地表明垫圈是环形金属片,并且它用于将两块木头螺栓连接在一起的过程中。

6. 你的句子是否简洁?

  • 在工作环境中,读者都很匆忙,他们最不想做的事情就是阅读本可以用一句话表达的信息段落。冗长的句子需要更多时间阅读,并会让你主要观点周围造成混淆。确保你向受众展示的信息与你的论点相关。

修订的关键步骤

[编辑 | 编辑源代码]

修订文档涉及三个主要步骤。请记住,这三个步骤通常在修订时一起进行,但在从全局角度来看时,仍然需要将它们视为独立步骤

1. 从读者的角度识别草稿中可以改进的地方。 通过此操作,您需要以完成文档后将阅读文档的人员的角度通读文档。修订时,请考虑以下标准:您的读者是否会发现该文档对他们有用或有帮助?它是否是一份有说服力的文档?从受众的角度通读文档时,是否达到了撰写文档的目的?

2. 确定可以对草稿进行哪些改进。 在工作环境中,您很可能面临截止日期和其他需要处理的责任的压力。明智地利用您用于修订的时间非常重要。查看您的草稿,并确定需要进行的最重要的改进,以及在您可用的时间内哪些改进将产生最大的改进。

3. 进行您认为重要的更改。

在工作场所中,关于改进文档,最常用的两种方法是

  • 检查 仔细检查您的草稿,查找出现的任何错误或差异。
  • 审查 参考那些原本不会成为您的文档目标受众的人。询问他们是否觉得您的文档足够有说服力,并且他们是否理解它。此外,让他们检查草稿的可用性。

检查您的草稿

[编辑 | 编辑源代码]

使用以下五个简单的要点,确保您知道在检查草稿时需要查找什么。您最不想做的事情就是向您的同事和上司提交一份包含错误的非专业文档。


1. 与您的工作保持距离,以获得其他读者的视角。

  • 请记住,由于您知道自己想要表达的意思,因此很容易错过工作中的错误,有时您也会这样阅读。

2. 仿佛您是目标受众一样阅读。

  • 考虑他们的专业知识水平
  • 要有说服力
  • 考虑他们的时间限制

3. 从雇主的角度考虑您的文档。

  • 请记住,即使在内部沟通中,您也始终代表着您的雇主
  • 不要替他人说话,或代表其他员工或您的雇主做出承诺
  • 确保文档合适,并符合公司的首选格式

4. 从可能受到影响的公司外部人员的角度阅读您的草稿。

  • 再次,考虑受众是谁,以及文档中是否有任何损害组织利益相关者的信息

5. 多次通读您的草稿。

  • 每次通读草稿时,都尝试每次专注于不同的问题
  • 确保您能发现您或您的文字处理器在编辑过程中可能错过的任何错误

审查您的草稿清单

[编辑 | 编辑源代码]

在审查草稿时,请将以下三个要点作为清单。


1. 为审查做好准备。

  • 审查的目标是什么?多次通读您的文档,每次专注于编辑的不同方面。例如,在第一次通读时,专注于拼写和语法,在第二次通读时,专注于消除被动语态,等等。
  • 沟通的目标是什么?牢记沟通的目标有助于您找到并消除冗长的句子和段落。


2. 提供评论和建议。

  • 确定最重要的修订。始终最好先解决主要问题,以便将其排除在外。当时间紧迫时,这一点尤其重要。
  • 说明修订的原因。在回顾修订时,了解进行修订背后的逻辑始终很有帮助。


3. 使用计算机软件来帮助。

  • 计算机软件可以帮助您发现拼写和语法等小错误,但不要过于依赖它们。请记住,计算机软件只考虑拼写,而不考虑正确的词语使用。拼写检查是一个好的第一步,但自己多次通读文档是最好的全面方法。

记录参考文献

[编辑 | 编辑源代码]

记录您的信息来源是符合道德规范的,并且使您的文档对读者更有价值。

选择您的文档风格

在工作或学校写作时,您需要确认您的二手资料来源。这些可能包括阅读材料、访谈、网站、讲座以及其他印刷和非印刷材料。正确准确地记录来源对于避免剽窃非常重要。当直接引用、释义或概括其他作者的材料时,您需要引用来源。

如今,写作中使用的文档风格似乎不计其数,对于作者来说,选择一种可能会让人不知所措。重要的是选择最适合的一种,并为保持一致性而坚持使用它。有两种广泛使用的内联文档风格:作者-页码和作者-年份。


  • 作者-页码系统:作者-页码系统由现代语言协会 (MLA) 使用。此风格要求在使用信息后括号中包含作者的姓氏和信息来源的页码。例如:猛禽通常在硬木树上高处筑造大型巢穴 (Nestor 204)。


  • 作者-年份系统:作者-年份系统通常由美国心理学会 (APA) 使用。此风格要求在引用中包含作者的姓氏和原始作品的出版年份。例如:在第二次世界大战期间,女性的就业机会大大增加 (Milkman 1998)。


在每种风格中,都包含一个详细的参考文献页面或书目,供读者参考。此页面应向读者提供查找您在引用中使用的确切文档所需的所有信息,以便他们希望获得更多信息或检查来源的可信度。更多信息可在 写作中心手册 中找到

华夏公益教科书