Writing procedures that aren't so straightforward

[Julia Norquist <julia_norquist -at- yahoo -dot- com>]

I am a technical writer, but I have not learned the
"right" way to do things. I have written user guides
in the past and am working on one now, but I need help
to write this guide in the clearest, most
straightforward way possible.

I've read the MSTP and Hargis's _Developing Quality
Technical Information_. The problem is that no matter
where I turn for help, I can't find the solution to my
problem. I know how to organize procedures according
to real tasks, and to keep them short and precise, but
some of my procedures have a lot of variables.

I am writing a guide for people who will use our
software on handheld computers, such as Pocket PCs. An
administrator will set up the software according to
how their company operates, and these settings will
affect what the end user sees on his screen. After
logging in, he may see a screen that will ask for an
additional password. He will proceed through a series
of screens, but the path is not linear. He might do A,
B, C, D, then E. He might do A, skip B, do C and D,
and skip E. He might skip A, do B and C, do B again,
and so on.

I can't split the tasks into a dozen or so
permutations, as in, "If your company does A and B,
and you have permission to do X but not Y, then do
this. If your company only does A, but you have
permission to do X, Y, and Z, then do that." The guide
would be huge.

The tasks themselves are not difficult. I just need a
good way to introduce a bunch of potential steps the
user will have to take, without turning the guide into
a Choose Your Own Adventure novel ("If you see the ABC
screen, turn to page 8. Otherwise, turn to page 10."
No way.)

Thanks for your help!

__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.