请点击这里以获得帮助 David McMurrey 付费用于网站托管:
捐出你能给的任何小额金额!
Online Technical Writing akan terus percuma.
The audience of a technical document—or any piece of writing for that matter—is the intended or potential reader or readers. For most technical writers, this is 最重要的 考量在规划、写作和审核文档时。你会调整你的写作,以迎合将要阅读你作品的读者的需求、兴趣和背景。
The principle seems absurdly simple and obvious. It's much the same as telling someone, "Speak in a way that the person in front of you can understand." It's like saying, "Don’t use complicated language with your six-year-old." Do we need a course for that? Doesn’t seem like it. But, in fact, not analysing the audience and adapting is one of the main reasons for most of the problems you see in professional, technical documents—especially instructions where it shows up the most.
笔记:
- 一旦你读完有关受众的部分,试着使用这个 观众计划者. 你填写空白,回答关于你的听众的详细问题,然后把它电邮给自己,选项也可以给你的讲师。
- 另外,这一章包括一个关于 situation. 尝试使用这个 situation planner 以了解你观众所处的情况。
其中一个分析观众时要做的第一件事是确定其类型(或类型—通常不止一种类型)。观众的常见分类如下:
- 专家: These are the people who know the theory and the product very well. They designed it, they tested it, they know everything about it. Often, they have advanced degrees and work in academic settings or in research and development areas of the government and tech sectors. The average reader is least likely to understand what these people are saying but also has the least reason to try. More often, the challenge for the expert is to communicate effectively to the technician and the executive.
- 技术人员: 这些人负责建造、操作、维护和修理专家设计和理论上的东西。他们的知识也非常专业,但更具实用性。
- 高管: These are the people who make business, economic, administrative, legal, governmental, and political decisions on the things that experts and technicians work with. If it's a new product, they decide whether to produce and market it. If it's a new power technology, they decide whether the city should implement it. Executives are likely to have as little technical knowledge about the subject as nonspecialists.
- 非专业人士: 这些读者的技术知识是最少的。他们的兴趣可能和技术人员一样实用,但方式不同。他们想理解新的电力技术,以便知道在即将到来的债券选举中是投赞成票还是反对票。或者,他们可能只是对某个特定的技术问题感到好奇,想要了解它,但没有特定的实用理由。
观众分析
重要的是要确定你的文件潜在读者属于刚才讨论的四个类别中的哪个,但这还不是全部。无论属于哪个类别,受众还必须根据以下特征进行分析:
- 背景—知识、经验、培训: 你其中一个最重要的考虑就是你可以期待读者拥有多少知识、经验或培训。如果你预期一些读者缺乏某些背景,你是否会在文档中自动提供这些信息?考虑一个例子:假设你正在编写一个关于在 Microsoft Windows 下使用软件产品的指南。你可以期待读者对 Windows 知道多少?如果有些人可能对 Windows 知之甚少,你是否应该提供这些信息?如果你说不,那么你就有可能让顾客对你的产品感到失望。如果你说是的,增加关于 Windows 的背景信息,虽然你增加了工作量,也会使文档的页数增加(因此成本也会增加)。显然,这个问题没有简单的答案——答案的一部分可能涉及到有多少小部分受众需要那个背景信息。
- 需要和兴趣: To plan your document, you need to know what your audience is going to expect from that document. Imagine how readers will want to use your document; what will they demand from it. For example, imagine you are writing a manual on how to use a new smartphone—what are your readers going to expect to find in it? Imagine you're under contract to write a background report on global warming for a national real estate association—what do they want to read about; and, equally important, what do they not 想读关于什么?
- 不同的文化: If you’re writing for an international audience, keep in mind that the way we show time and dates, money amounts, and numbers can differ worldwide. Also, remember that jokes and figurative expressions (like "hit a home run") might not be understood outside our culture. Texas A&M University provides Chapter 6, "写给国际读者的," 的 报告技术信息, Elizabeth Tebeaux, et al. For standards, see 风格指南列表 dari Wikipedia. (Terima kasih kepada tamu tanpa nama yang menyumbangkan idea-idea penting ini.)
- 其他人口特征: 当然,还有很多关于你的读者的特点, 可能 有影响于你应该如何设计和撰写你的文档—例如,年龄组、居住类型、居住地区、性别、政治倾向等等。
Audience analysis boleh jadi rumit oleh sekurang-kurangnya dua faktor lain: pelbagai jenis penonton untuk satu dokumen, ketidaktentuan luas dalam audiens, dan audiens yang tidak diketahui.
- 多个观众。 You probably realise that your document is meant for more than one audience. For instance, it might be read by technical folks (experts and technicians) as well as administrative staff (executives). What should you do? You can either write all sections in a way that all audiences can understand (good luck!). Or you can tailor each section specifically for the intended audience, using headings and introductions to guide your readers on where to go and what to skip in your document.
- Audience sangat berbeza-beza. You may realize that, although you have an audience that fits into only one category, there is a wide variability in its background. This is a tough one—if you write to the lowest common denominator of reader, you're likely to end up with a cumbersome, tedious book-like thing that will turn off the majority of readers. But if you don't write to that lowest level, you lose that segment of your readers. What to do? Most writers go for the majority of readers and sacrifice that minority that needs more help. Others put the supplemental information in appendices or insert cross-references to beginners' books.
Audience-Analysis Contoh
If you are taking a technical-writing course, you may be expected to add an audience description to your technical documents. Here's an example:
| 请注意: 这些说明是为那些希望通过使用宏来高效计算数据的个人提供的。他们了解如何在Microsoft Excel中输入数据,并对Microsoft Office套件有基本知识。他们对使用Windows软件感到舒适,并且具备基本的算术能力,以便验证他们的计算并检查计算中的逻辑错误。 |
听众适应心得
Okay! So you’ve studied your audience until you know them even better than yourself. What’s the point? How do you use this info? How do you avoid writing something that’s still hard to understand or useless for your readers?
写作的业务 到 你的听众可能与天生的才能、直觉,甚至神秘感有很大关系。 但有一些手段你可以使用,以更好地与读者联系。 以下的"控制"主要与使技术信息更易于非专业观众理解有关:
- Add information that readers need to understand your document. Check to see whether certain key information is missing—for example, a critical series of steps from a set of instructions; important background that helps beginners understand the main discussion; definition of key terms. (See the chapter on content ideas untuk maklumat lanjut.)
- 省略读者不需要的信息。 不必要的信息也会让读者感到困惑和沮丧,因为他们会觉得有义务去读这些内容。比如,你可以把基本指令中的理论讨论删掉。
- 更改您当前拥有的信息的级别。 You may have the right information but it may be "pitch" at the wrong level of technicality. It may be aimed at the wrong audience—for example, directed at experts instead of technicians. This usually happens when product-design notes are mistaken for instructions.
- 加上例子以帮助读者理解。 Examples are one of the most powerful ways to connect with audiences, especially in instructions. Even in non-instructional text, like when you’re trying to explain a technical concept, examples are a big help—analogies in particular.
- 调整你的例子的水平。 你可能在使用例子,但技术内容或水平可能不适合你的读者。简单的例子对专家可能没用;高度技术性的例子可能完全不适合你的非专业读者。
- 改一下你的资料组织。 有时,你可能拥有所有正确信息,但排列得不对。例如,前面的背景信息可能太多(或太少),导致某些读者迷失方向。有时,背景信息需要整合到主要信息中,比如在说明中,有时在需要时提供背景信息的相关部分会更好。 (参见章节) struktur and 组织 的文件中的信息。)
- 加强过渡。 读者,特别是非专业人士,可能会发现很难看出你文件主要部分之间、单个段落之间,甚至有时单个句子之间的联系。你可以通过添加来让这些联系更加清晰。 过渡词 和通过回声 关键词 more accurately. Words like "therefore," "for example," "however" are transition words—they indicate the logic connecting the previous thought to the upcoming thought. You can also strengthen transitions by carefully echoing the same key words. In technical writing, it's not 一个好主意是变化用词—不要用同样的词,这样人们不会比他们已经感到的更困惑。(参见关于 过渡.)
- 写更强有力的引言—整体文档及各个主要章节。 People seem to read with more confidence and understanding when they have the big picture, a view of what's coming, and how it relates to what they've just read. Therefore, make sure you have a strong introduction to the entire document—one that makes clear the topic, purpose, audience, and contents of that document. And for each major section within your document, use mini-introductions that indicate at least the topic of the section and give an overview of the subtopics to be covered in that section. (See the chapter on 介绍 两个完整报告和报告内的各部分都适用。
- Sure, here are some topic sentences for paragraphs and paragraph groups: 1. **Environmental Issues** The increasing impact of climate change demands urgent action from individuals and governments alike. 2. **Technology in Education** Integrating technology into classrooms enhances student engagement and facilitates personalized learning experiences. 3. **Health and Wellness** Prioritizing mental health is as crucial as maintaining physical health for overall well-being. 4. **Economic Development** Sustainable economic growth relies on innovation and smart resource management to create job opportunities. 5. **Cultural Diversity** Embracing cultural diversity enriches communities and fosters mutual respect and understanding. 6. **Social Media Impact** The rise of social media has transformed the way people communicate and interact in modern society. 7. **Travel and Tourism** The travel industry plays a vital role in promoting cultural exchange and economic growth globally. 8. **Food Security** Ensuring food security is essential for combating hunger and promoting health in populations worldwide. 9. **Urban Development** Sustainable urban development strategies are essential in creating livable cities for future generations. 10. **Family Dynamics** Understanding the evolving nature of family dynamics can help strengthen relationships and foster healthier homes. It can help readers a lot to give them an idea of the topic and purpose of a section (a group of paragraphs) and especially to provide an overview of the subtopics that will be covered. Roadmaps are useful when you're in a different state! (See the chapter on using overviews and topic sentences.)
- Sure! Please provide the sentence you would like me to modify. How you write—down at the individual sentence level—can make a big difference too. In instructions, for example, using imperative voice and "you" phrasing is vastly more understandable than the passive voice or third-person phrasing. For some reason, personalizing your writing style and making it more relaxed and informal can make it more accessible and understandable. Passive, person-less writing is harder to read—put people and action in your writing. Similarly, go for active verbs as opposed to be 动词短语。这些都让你的写作更直接,更具时效性—读者无需费力去寻找。 (参见该章节关于 一般句式问题 for details.)
而且,句子的长度也是很重要的。每句大约15到25个单词是合适的;超过30个单词的句子要怀疑。 - Improve sentence clarity and conciseness. This is closely related to the previous "control" but deserves its own spot. Often, writing style can be so wordy that it is hard or frustrating to read. When you revise your rough drafts, put them on a diet—go through a draft line by line trying to reduce the overall word, page or line count by 20 percent. Try it as an experiment and see how you do. You'll find a lot of fussy, unnecessary detail and inflated phrasing you can chop out. (See the chapter on 常见的句子风格和清晰度问题 for details.)
- 用更多或不同的图形。 对于非专业观众,你可能想要用更多的图形—而且要简单一些。专业人士的图形更为详细,更具技术性。在非专业技术文档中,通常会有更多的"装饰性"图形—这类图形虽然吸引人,但并没有严格的信息或说服目的。(请参见章节中 grafik untuk butiran.)
- 将文本拆分或整合成有意义、可用的块。 对于非专业读者,你可能需要将段落缩短。一般来说,6 到 8 行的段落是通常的最大长度。注意专业人士撰写的技术文件中的段落有多长。
- Add cross-references to important information. In technical information, you can assist readers who aren't experts by directing them to background sources. If you can't completely explain a topic immediately, refer them to a section or chapter where it is covered. (See the chapter on 交叉引用 untuk maklumat lanjut.)
- **Heading 1: Guidelines for Effective Communication** **Heading 2: Key Points** - Speak clearly and concisely. - Listen actively to others. - Use appropriate body language. - Maintain a positive attitude. **Heading 3: Best Practices** 1. Be respectful and courteous. 2. Ask questions if unsure. 3. Offer constructive feedback. 4. Stay on topic during discussions. Readers might feel overwhelmed by large, dense paragraphs of writing, broken only by the occasional blank line. Check your rough drafts for opportunities to add headings—look for shifts in topic or subtopic. Search your writing for lists of items—these can be turned into vertical lists. Look for paired listings like terms and their definitions—these can be structured into two-column lists. Just be cautious not to impose this special formatting excessively—don't go overboard. (Refer to the chapters on tajuk and lists untuk maklumat lanjut.)
- 使用特別排版,並調整邊距、行長、行距、字體大小和字體樣式。 对于非专业读者,可以采取一些措施,比如缩短行距(收紧边距)、使用更大的字体,以及其他类似的策略。某些字体风格被认为比其他字体更友好和更易读。(尝试找一个参与出版的人来了解字体的见解。)
These are the kinds of "controls" that professional technical writers use to finetune their work and make it as clear as possible. And in contrast, it's the accumulation of lots of problems in these areas —even seemingly trivial ones— that add up to a document being difficult to read and understand. Nonprofessionals often question why professional writers and editors insist on bothering with such seemingly picky, trivial, petty details in writing — but they all add up! It reminds me of the ancient Chinese execution method called " death by a thousand cuts. " However, in this case, it would be " perplexity by a thousand minor problems. "
情况分析与发明
单单选择一个主题和定义一个受众并不足够。你需要知道(或创造)这个 situation di mana audiens ini beroperasi—apa matlamatnya: menyelesaikan masalah, membolehkan penambahbaikan, menyokong pengambilan keputusan? Situasi untuk penulisan techdoc mungkin tidak terhad seperti hubungan sosial manusia. Situasi techdoc melibatkan audiens yang memerlukan atau meminta jenis techdoc tertentu untuk keperluan dan kegunaan spesifiknya. Untuk butiran lanjut, sila lihat 情况分析与发明
相关信息
利用调查来发掘观众洞察. BrightTalk
观众. Universiti North Carolina di Chapel Hill
Saya hargai pendapat, reaksi, dan kritikan anda mengenai bab ini: Sorry, I need the text you want translated into Singaporean English. Please provide it, and I'll help you with the translation!—David McMurrey
