Gene Kim-Eng wrote: >>"Theory of Operations" (or "functional description" or other title) are seldom, if ever, "information needed to help them get everything back online as fast as possible." More often than not they are the ignored frontmatter that people grumble about as they search for a quick explanation of why a widget is suddenly hitting a frammistat and how to replace one or both.
A completely independent section that explains in excrutiating detail how the entire system, including all of its 376 widgets and frammistats, work together is at best trivia for the proud new owner and at worst the part of the document that people always complain that they have to wade through to find the infomation they really need at the moment.<< Uh...okay. First, the "Functional Description" was included in the service manual at the request of the Customer Service Department...the people who have to fly across the world to service the system at a moments notice. Second, feedback from our customers indicates that the Function Description is not ignored front matter. I get more compliments about adding it than I get grumblings about sticking it in the appendices. Finally, nobody ever said that the Functional Description should explain things in "excruciating detail." In fact, I said exactly the opposite. I will agree, however, that the Service Manual should be designed so users can find useful information rapidly. Incidentally, I write hardware/software documentation for a company that makes microelectromechanical manufacturing systems (wafer bonders), so I probably write to a niche market full of geeks who get off on technical drivel. Does that make me tainted....or demented? Al Geist Technical Writing, Help, Marketing Collateral, Web Design and Award Winning Videos Voice/Msg: 802-872-9190 Cell: 802-578-3964 E-mail: mailto:[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
