RE: Usability

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

Heidi,

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
manual.

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.

Good luck!

Don White
Technical Writer
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

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.


Previous by Author: RE: The Big Lie (was 'Are You a Writer?')
Next by Author: RE: The Big Lie (a prediction)
Previous by Thread: RE: Usability
Next by Thread: FrameMaker question on mixed page settings (x-x versus x)


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads