Re: Writing procedures that aren't so straightforward

[Stuart Burnfield <slb -at- westnet -dot- com -dot- au>]

You could just document each individual screen as a standalone task. If 
I've just logged in, supplied my password, successfully done steps A, C 
and D, then had a problem with step F, I'd just open the guide and skip 
straight to the topic that explains F. I wouldn't need to read about all 
my preceding steps in order.

Think of it like a command reference for a programming language. The 
commands might be used in almost any combination. We just document each 
command in a separate topic, so coders can jump to the command they're 
interested in.

Another thing you could do is put the scope at the top of each topic. 
For example you could have a mini-checklist saying:

This topic applies to:
    Roles: Supervisor, Administrator, Operator
    Modes: online, offline
    Tasks: M, N, P

Stuart

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: 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.