English 421Y: Technical Writing Online

This weeks readings, including chapters 19 and 20 from TCT, discussed the various aspects of constructing a thoroughly developed instructional document. One of the most important parts analyzed was the research that should go into creating such a document, including a solid identification and awareness of all audiences involved. An understanding of the user and the context in which the instructions will be used allow for the writer to gain a strong understanding of the writer’s perspective and speak in an appropriate, fitting tone.

As I started to read though these articles, I began to think of the same impressions the last time I had to follow documented instructions. I, like most mechanically raised individuals, ignore them for as long as I can and try to understand the objective myself. The reason many people choose to do this is not because they want to prove they are smarter than the apparatus (however I may be guilty of this), but because the instructions that are provided are so unappealing to the type of audience that typically read them.

This week’s reading response covers chapters 19 and 20 and is about writing technical instructions. The main focus in these chapters is tailoring your documents to your audience and their needs. This seems to be an emerging theme between all technical writing—audience analysis and context.

This week’s readings focus on what needs to be included in written instructions and technical descriptions. Chapters 19 and 20 reiterated the fact that when you use writing to convey any kind of message you need focus on your audiences needs. It stated that you should use the 5 W’s and H questions to help you include the proper information. I think that the video from Common Craft shows a very well put together presentation on how to use Google docs.

In Instructor Blog #4 they warn us about treating the user reading the instructions as “idiots.” The drawback to this is that when you are writing your manual you would be talking down to user.

Instructions are a funny thing. We like to claim that we can do without them, but the reality is sometimes they are necessary. However, when you actually crack open the user’s manual it’s hard to find what you are looking for. Thankfully, I have the internet and more importantly, Google. If I ever find myself in need of an answer or directions, I just search on the internet. No point in wasting time looking for the user’s manual.

These chapters offered interesting pointers about technical descriptions and instructions. I found the most helpful part of the chapters in Chapter 19, where the reading gave tips on the style you should use when writing technical descriptions.

After doing all of the readings for the week, it seems that just like resumes, the fate of instructions can largely rely on the design and layout. One thing that always guarantees that I will not read instructions is seeing a bunch of large blocks of text with no graphics. I have found that, as the readings state, it is much easier to learn something and follow instructions when visual aids are used. Sometimes words can be confusing, especially if instructions are written at a higher level than my knowledge.

What hit the closest to home for this week was in “Instructor Blog #4: Technical Instructions.” It speaks of how successful video game instructions are built into the game so that you learn while performing the task itself. I almost always skip looking at the instructions of a new game. It just always seems easier to jump in and learn by doing. Unfortunately, in most situations you may not be able to merge the instructions directly into the task and skipping them may result in a lost life (and not just the virtual kind).

The video about Google docs was a good example of instruction because it used such simple language and enforced everything with a visual representation. Many people wouldn’t even realize that there were now 4 copies of a document that they had just sent out as an attachment. But after seeing this video, I’m sure that they could see the problem with using email attachments and the benefits of using Google docs.