RE: Software Manuals

Subject: RE: Software Manuals
From: "Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>
To: "Johnson, Joyce" <JJohnson -at- abc-sg -dot- com>, "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>
Date: Tue, 17 Jul 2007 10:21:41 -0400

This is a safety-critical system. Mistakes can have serious
consequences. You want users to have a good mental picture of what they
should do, and how to recognize oddities and error states.

I'd make sure there were coherent step by step procedures for each major
task, with enough info to help users remember them.

I'd also put in some task cards (lean step by step descriptions of major

If you think users might want to get a coherent picture of the app when
they're not in front of the machine, full-scale with screen shots are
probably justified.

- Jessica


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Re: Software Manuals: From: Caroline Tabach
RE: Software Manuals: From: Johnson, Joyce

Previous by Author: RE: Software Manuals
Next by Author: Unusual user
Previous by Thread: RE: Software Manuals
Next by Thread: Re: Software Manuals

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

Sponsored Ads