RE: Software Manuals

["Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>]

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

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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.