TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Usability From:Donald -dot- H -dot- White -at- pmusa -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 5 Mar 2002 14:51:52 -0500
Your website shows a very good example of a maintenance manual. True, the
manual for your company's Ht-146 H Series Thermal Printer is called a "User
Manual," but it has most characteristics of a good hardware maintenance
There's not a lot of difference between the two species. Organize according
to types of maintenance; include in-line graphics showing particular points
of maintenance and QuickTime movies demonstrating assembly, disassembly,
lubrication, and so forth. Be sure to offer an appendix or chapter for
troubleshooting that includes all know issues and their resolutions, again
with graphics or movies, as appropriate.
Use your company's basic style guide--if the manual I looked at is an
example, it's a good guide. Just remember to change the title to Maintenance
Manual from User Manual.
dwhite -at- venturipartners -dot- com
Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002. www.ehelp.com/techwr
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.