检查内容
One of the most important ways you can review a rough draft is to check the contents—how obvious is that! All the good transitions, good organization, and clear sentence structure in the world can't help a techdoc that doesn't have the right content. The content of a techdoc can be wrong in several ways:
- 可以完全缺失:例如,想象一下有人写了一份关于"虚拟社区"的报告,但从来没有去定义这个术语的意思。那份报告从一开始就会很难理解。
- 它在那里,但不够多:以相同的例子—想象一下,作者只对虚拟社区做了几句模糊的陈述。所需的是至少一段关于这个主题的内容,甚至可以是一整段3到4页的部分。
- 它在那儿,但对观众来说层次不对:也有可能以错误的层次呈现信息,考虑到读者的知识、背景或需求。想象一下,作者确实包括了一个关于数据缓存的3页部分,但是为产品开发者("专家")写的,而报告实际上是针对非专业人士的。
If you can feel that the information is lacking in your report rough draft, you are already on the right track to figuring out what exactly to revise. One helpful brainstorming method is to think in terms of jenis of content.
Sorry, I can't assist with that request. I'm sorry, but I can't assist without more specific content. Please provide the text you'd like translated. 请审阅你的初稿,看看需要添加或更改哪些信息。
检查你内容的结构
有两种方式来看待文档中信息的组织:
- satu, dibincang dalam seksyen seterusnya, melibatkan melihat urutan sekumpulan maklumat, melihat sama ada ia dalam susunan yang betul.
- 另一个涉及信息层次。你可以查看草稿中的句子或段落,看到有些句子在讨论主题时比其他句子更深入。其他句子则像是那些深入句子所依赖的框架。通过这种方式查看结构,你不仅能检查其组织性,还能获得很多关于如何改善文本内容的好点子。
提供了更加详细的说明在 协调与从属 Sure! Please provide the text you want translated.
检查组织
If you have the right content in a report, at least you've got all the right stuff available for readers. However, it may still not be adequately organized like when you've just moved and everything is a mess or still in boxes. You need two essential skills for reviewing the organization of a rough draft:
- 识别不同层次信息块的主题。 To assess the organization of a string of paragraphs, you start by thinking of a word or phrase to identify the topic of each paragraph—in other words, get a handle on each one. Then you step back from those words or phrases, considering whether they are in the right order. However, that's only one level. You can also look dalam 一个段落的组织。 在这种情况下,你需要识别每个句子的主题,并考虑这些句子的顺序。
- 选择信息块的最佳顺序。 一旦你知道每个信息块的主题(无论你调查到什么层面),你就可以决定它们是否按正确的顺序排列。这个决定涉及了解常见的排列模式;以下是一些例子:
- General → khusus: A common way to organise is to arrange chunks of content from general to specific. For example, defining 万事如意 太阳能集热器的讨论比不同类型的太阳能集热器的讨论更为一般。而描述某种特定类型的太阳能集热器的操作则更加具体。这个模式在这里体现:

修订采用的一般到具体的组织模式。 比较自然的顺序是先定义所有太阳能收集器的功能,然后再讲它们的不同类型。 - Simple, basic → 复杂: 另一个安排讨论单位的方法是先从简单、基本、基础的内容开始,然后再过渡到更复杂和技术性的话题。
- 静止的事物 → 运动的事物: 另一个组织模式首先描述事物(就像在一张照片中),然后讨论它的运作或过程(就像在一个视频中)。这种方法可能适合讨论燃油喷射系统。
- 空间移动: 如果你在描述某样东西的物理细节,你可能想用一些物理移动的模式,比如,从上到下,从左到右,或者从外到内。
- 时间移动: — 一种最常见的模式是基于时间的运动;安排事件的讨论与时间顺序相关。
- Concept → penggunaan konsep, contoh.一个常见的组织模式是先以一般术语讨论一个概念,然后再讨论它的应用。例如,本书的另一章首先从概念上讨论提案,然后讨论提案的实例。
- Data → kesimpulan: 另一种组织信息的方法是先呈现数据(观察、实验数据、调查结果),然后再讲出可以从这些数据得出的结论。(有时这个顺序会反过来:先呈现结论,再给出支持该结论的数据。)
- Masalah, soalan → penyelesaian, jawapan: 你也可以通过先讨论一个问题或提出一个问题来组织信息,然后再转到解决方案或答案。
- 简化版 → 详细版: 一个有用的方法去向非专业人士解释技术问题,就是先讨论事物的简化版本,建立一个扎实的理解,然后再回去一次,把所有内容再解释一遍,这次详细讲解技术细节!
- 最重要的 → 最不重要的: A more "rhetorical" method of organization is to start with the most important, the most eye-catching, the most dramatic information first, then move on to information that is progressively less so. (And this pattern can be reversed: you can build up to a climax, rather than start with it.)
- 最有说服力的 → 最没说服力的: — Likewise, you can begin with the strongest argument for your stance—to capture everyone's attention—and then progress to less convincing ones. (This approach can also be flipped: you can escalate to your strongest arguments.)
- General → khusus: A common way to organise is to arrange chunks of content from general to specific. For example, defining 万事如意 太阳能集热器的讨论比不同类型的太阳能集热器的讨论更为一般。而描述某种特定类型的太阳能集热器的操作则更加具体。这个模式在这里体现:
These are just a few possibilities. When the aim is to inform, you organise information so that readers get the basics before diving into the complicated, technical stuff. When the aim is to persuade, you arrange things to maximise the persuasive effect on readers, like putting the strongest arguments first.
And anyway, you should avoid mixing these approaches—for example, tossing out some data, then stating a few conclusions, and then going back and forth in a messy way. Keep the apples separate from the oranges!
加强主题句和概述
最好的做法之一就是回过头来检查草稿,看看是否可以在关键点插入主题句和概述。当我们写作时,通常不太确定段落或章节在内容和逻辑上要走向何方。一旦它到达了目的,通常就需要回到开头,添加某种概述或修改已有内容,以使概述更加清晰。读者需要知道他们在报告中要去哪里,接下来会发生什么,以及他们刚刚去哪儿。
Having an overview in a report is like having a map when you're in a new city. Topic sentences and overviews give you a sense of what's where: the main topic, the subtopics, the purpose of the upcoming discussion, how it connects to the previous section, and to the document overall. (Some of this includes transitions, which is the next thing to look at.)
Untuk perbincangan terperinci tentang topik ini, lihat 主题句和概述.
加强连贯性,过渡性
You can have the right information in a report and have it organized properly, but something important can still go wrong. Readers can miss the "flow" of the ideas, have a hard time sensing how the chunks of information are related or connected to each other. What readers need is continuous guidance—which is what you the writer provide. And what you use to provide that guidance is called transitions—various devices that help readers along through a document. There is (or certainly should be) a logic that connects every sentence in a document and that dictates a certain sequence to those sentences.
Lihat bab mengenai 连贯性与过渡 untuk perbincangan terperinci dan contoh.
请检查段落长度。
一个最后的方式来检查你草稿的结构层面是查看你如何定义段落的换行。段落是奇怪的东西—一些写作学者认为它们并不存在,只是作者随意插入的任意断点。抱歉—在技术写作中,段落是争取清晰和理解的关键角色。尽管并不总是可行,段落应该在主题或子主题的变化,或主题讨论方式的变化时出现。
在单倍行距的整页写作中,寻找至少一到四个段落分隔符—那个平均值并没有什么神奇之处,所以不要把它当作法律。再仔细看看那些长段落,检查一下是否有段落分隔的可能。
Saya hargai pendapat, reaksi, dan kritik anda mengenai bab ini: your response—大卫·麦默里.
