Chapter 1 Summary - Guidelines for Developing Instructions (Haupt)
Chapter 1 serves as an introduction to the book. Noteworthy in this chapter are the revelations that the authors have abandoned the commonly used approach of task analysis in developing instructions, and the widely used methodology of book design. Rather, the book teaches a method focused on human factors engineering.
I find it interesting that the authors have not chosen to address the requirements of ISO 9000 (including Conformance Models 9001, 9002, and 9003) when discussing procedure writing. ISO 9000 is an international standard for process, procedure, and work instruction documentation. It is the business process and procedure element of the Malcolm Baldridge National Quality Award Criteria. Many large and/or international companies adhere to the methodology of ISO 900o in their procedure documentation.
The book stresses the importance of graphics in procedure writing. The book stresses a team approach to be used in writing procedures, including the involvement of graphic artists.
Technical writing commonly involves a team approach. It is customary for technical writers to work with subject matter experts (SMEs) in the development of procedures. It has been my experience that most technical writers are not as proficient technically as they are in the art of writing. This lack of technical knowledge on the part of technical writers creates an environment in which they rely on SMEs for direction in their writing projects. The book explains how to produce documentation with the assistance of various team members including writers, editors, graphic artists, management, and SMEs (typically engineers).
Also receiving special attention is the subject of maintenance documentation. Technical writers usually create procedures in three different phases of a product life cycle including design, training, and maintenance. Typically, these documents are dynamic - constantly being updated as revisions become necessary due to design changes, software upgrades, changing hardware specifications, and training requirements.
I find it interesting that the authors have not chosen to address the requirements of ISO 9000 (including Conformance Models 9001, 9002, and 9003) when discussing procedure writing. ISO 9000 is an international standard for process, procedure, and work instruction documentation. It is the business process and procedure element of the Malcolm Baldridge National Quality Award Criteria. Many large and/or international companies adhere to the methodology of ISO 900o in their procedure documentation.
The book stresses the importance of graphics in procedure writing. The book stresses a team approach to be used in writing procedures, including the involvement of graphic artists.
Technical writing commonly involves a team approach. It is customary for technical writers to work with subject matter experts (SMEs) in the development of procedures. It has been my experience that most technical writers are not as proficient technically as they are in the art of writing. This lack of technical knowledge on the part of technical writers creates an environment in which they rely on SMEs for direction in their writing projects. The book explains how to produce documentation with the assistance of various team members including writers, editors, graphic artists, management, and SMEs (typically engineers).
Also receiving special attention is the subject of maintenance documentation. Technical writers usually create procedures in three different phases of a product life cycle including design, training, and maintenance. Typically, these documents are dynamic - constantly being updated as revisions become necessary due to design changes, software upgrades, changing hardware specifications, and training requirements.
5 Comments:
I’d like to address the stresses put on the use of graphics in technical documents. Personally, I think that graphics can make or break a document. If the graphics are good, then the document is great. If the graphics are bad, then the document is an utter failure. I remember looking through an old—probably ten or fifteen years old?—car catalog of my dad’s and being just lost when it came to the graphics. They were crude line drawings that had little or no sense of what parts were what. However, a modern graphic I used in putting together a shelf was very useful to me. One graphic made me feel intimidated while the other was helpful and inviting. I’m not sure if it was the passage of time or what, but there was a large difference.
First of all, I agree that many technical writers are more skilled in writing than they are skilled with technical knowledge. That's why it's so important to work collaboratively on writing projects (specifically, involving engineers or experts in the writing process), so that the final document is thorough and correct. I also agree that visuals are a very important part of technical documents. Even the layout design of the document can affect how the readers use it.
I'd like to thank Carl for explaining what ISO 9000 is, because I've heard the name hundreds of times but never knew what it meant. I'm sure his technical knowledge from the field is going to be very valuable to our class this semester.
One think I'd like to point out about the stress placed on graphics is their universality. In other words, you don't need to speak english to understand a graphic. Last year, I assembled a very large entertainment center unit in my apartment using completely pictoral instructions. There was not one word on the instructions, just diagrams, arrows, illustrations, exploded images, and steps. Instructions like that must cut down on the complication of translating between languages.
I think there is great emphasis placed on collaboration in technical writing because of what you mentioned. One person may be good at a specific aspect of the project, while lacking in other areas. Therefore, I'm glad to read that collaboration is an essential part of the technical writing process. Myself, I am inexperienced with technical writing as a whole and therefore I would be benefited by working with a more experienced person. I guess it's just like any job, the more you do it, the more you learn.
Knowledge is the most important aspect of technical writing. I say that because if you know enough, you don't need pictures to have the audience see what you are describing.
Although, most of us aren't that good yet, myself included, and therefore visuals are also a necesssary evil. I say evil because they can make or break a document.
Post a Comment
<< Home