Depends on how enlightened management is :) Anyway, back to the OP questions:
For our papermaking machinery documentation, we do include a "Maintenance" chapter in all of our manuals, typically 10-20 pp., with the same use of white space, graphics, and other ways to make the information visually pleasing and accessible that characterizes the rest of the manual. The really detailed, specialized-beyond-the-average-reader stuff goes in the appendices. Contents of a fairly representative chapter runs like this: * Safety instructions for maintenance work * Lubrication * Inspection intervals * Opening and closing the machine * Removing and fitting component A * Removing and fitting component B, etc. We also have a standard "Technical Description" chapter that includes a brief "Principle of Operation" section that gives a very high-level synopsis of how the machine works and what it was designed to do. This chapter typically maxes out at 2-4 pp. Jim -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Gene Kim-Eng Sent: Friday, October 05, 2007 9:07 AM To: [email protected] Subject: Re: [TCP] service manuals Speaking as someone who "employs" tech writers, the bottom line is always a default. I'm just not sure whether "because management wants it" should be listed as a pro or a con in an answer to Joyce's question... Gene Kim-Eng ----- Original Message ----- From: "Tom Johnson" <[EMAIL PROTECTED]> > 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. ______________________________________________ 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 ______________________________________________ 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
