Chapter 4 describes 10 guidelines when planning to write for usability. These guidelines help you to write usable communication that is complete, task-oriented and accessible.
They are:
1.Identify the information your readers need
2. Organize around your readers task
3. Identify ways to help readers quickly find what they want
4. For a complex audience, plan a modular communication
5. Look for a technical writing superstructure you can adapt
6. Plan your graphics
7. Global guideline: Determine your readers' cultural expectations about what makes a communication usable
8. Outline, if this would be helpful
9. Check your plans with your readers
10. Ethics guideline: Investigate stakeholder impacts
What I found interesting about this chapter was in guideline #7. Some cultures have different criteria when determining if a communication is usable or not. For instance, the Chinese meet their readers' expectations by explaining the outcomes of the major steps but not each individual action required to complete the task. This is considered knowledge that the reader already possesses. I know that in the United States we tend to desire all of the individual steps when describing a certain task. I wonder if this stems from protecting yourself/company from possible lawsuits? I have seen often times details in written instructions that seem to be common sense (ie. let the vehicle engine cool down prior to changing the oil).
Chapter 5 describes 9 guidelines to use when planning your persuasive strategies.
They are:
1. Listen - and respond flexibly to what you hear
2. Focus on your readers' goals and values
3. Address - and learn from - your readers' concerns and counterarguments
4. Reason soundly
5. Organize to create a favorable response
6. Build an effective relationship with your readers
7. Determine whether to appeal to your readers' emotions
8. Global guideline: Adapt your persuasive strategies to your readers' cultural background
9. Ethics guideline: Employ ethical persuasive techniques
What stuck out to me in this chapter was guideline #4. This section describes what is involved when using sound reasoning. In addition to your claim and evidence you need to have a line of reasoning that links the evidence to your claim. I think that this link is often times what is missing in an otherwise good communication.
Chapter 16 talks about creating communications with a team. This chapter uses 8 guidelines for this purpose.
They are:
1. Develop a shared understanding of the communications objectives
2. Make and share detailed plans
3. Make a project schedule
4. Share leadership responsibilities
5. Make meeting efficient
6. Encourage discussion, debate and diversity of ideas
7. Use computer tools for collaboration
8. Global guideline: Be sensitive to possible cultural and gender differences in team interaction
I was impressed with guideline #6. Encouraging discussion and debate can sometimes be a bit tricky. With engineers there almost always seems to be one individual who wants to argue their point not matter what the cost. Keeping a debate over ideas from turning into a heated conflict is often times difficult. I enjoy having an intelligent debate with coworkers even if it means agreeing to disagree as long as each person can remain calm and not become too defensive.
Chapter 23 describes a superstructure to use when writing reader-centered instructions. This superstructure will help you when creating instructions that are both usable an persuasive. the superstructure for instructions has the following topics:
1. Introduction
2. description of equipment
3. List of materials and equipment needed
4. Directions
5. Troubleshooting
In this chapter there are several things to keep in mind when writing instructions such as:
1. Write clearly and succinctly
2. Use plenty of graphics
3. Design usable and attractive pages and screens
4. Test your instructions
Of these things I was most interested in testing your instructions. I have found that when writing instructions for a product your company produces it is easy to convince yourself and others that the instructions are clear and easy to follow. Often times we are too close to the product to consider that there are things that can seem obvious to us but to your intended reader is extremely confusing. I think that having someone test the instructions is a very good idea. I wonder how you could accomplish this on a new product prior to releasing it to market? Maybe you could have some test sites for this product and include the prototype instructions.
In conclusion, I found a lot of useful information in these four chapters. I am looking forward to using the group techniques in our upcoming project.