Joyce (if you're still with us), Gene and Al have provided an entertaining and informative discussion about including theory of operation in service manuals. Helping service people understand the theory may help them better understand how to repair something. On the other hand, too much information can make it harder for people to find the information they are looking for in what can be an already stressful situation.
I think a key to a successful manual is making the information accessible. You want to make it easy for people to use your manual. If you want to put the theory in, that's probably a good thing, but you need to find a way to delineate that from the "nuts and bolts repair information". Whether theory goes in an appendix or embedded in each section doesn't matter too much if you can create a good table of contents and an index or some other way of getting people to the service information. Even using page layout techniques or graphic elements can help delineate the service/repair information. The worst thing you can do when designing a manual is to create a monotonous landscape of indistinguishable text for people to slog their way through to find information. It is far better to somehow visually separate repair procedures from theoretical material. Good section headings and ample white space also work toward a friendly manual. I guess what I'm saying is that you can put as much information in a manual as you need, but you can still make it easy for people to quickly find and use the essential information. That isn't to say, by any means, that it might not be better to create separate manuals: one for theory and one for trouble-shooting and service. It all depends on your audience. Al has the bottom line absolutely right. You need to provide what your employer wants, but it's up to you to do the best you can within the guidelines your employer gives you. And, you need to help your employer make informed decisions. Tom Johnson -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Al Geist Sent: Thursday, October 04, 2007 7:17 PM To: 'Gene Kim-Eng'; [email protected] Subject: Re: [TCP] service manuals Gene Kim-Eng wrote: >>A lot probably depends on who the service manual is written for....I've spent most of my careers as engineer and writer/manager in narrow niches of varying geekness. At the highest level my document set contained an entire separate volume called "Functional Description." About 50% of recipients loved it; the rest probably never removed the shrink wrap.<< I'll have to agree with you on that last point. A lot of my best work is supporting that short leg on the service engineer's table. It keeps the desk steady and me from joining the ranks of the homeless. We write what those who pay out checks want us to write...bottom line. Al Geist Technical Writing, Help, Marketing Collateral, Web Design and Award Winning Videos Voice/Msg: 802-872-9190 Cell: 802-578-3964 E-mail: [EMAIL PROTECTED] URL: http://www.geistassociates.com (Online portfolio and resume) See also: URL: http://www.geistimages.com (Fine art photographic prints for home or office and beautiful note cards for all occasions.) ______________________________________________ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com _______________________________________________ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
