Re: Writing procedures that aren't so straightforward

Subject: Re: Writing procedures that aren't so straightforward
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 11 May 2007 08:42:52 +1000

Julia Norquist wrote:
>
> 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.
>

Really hard to answer this without more details
about the product and what A, B, X, and Y are...

Is there any way to categorize the different
activities not in a linear way but in a way that
describes the purpose ("To Use the Remote Email
Retrieval Screen")? Or is there a way to describe
standard installations so you can categorize different
possible setups ("To Login With User-Only Permissions"
"To Login With Administrative Permissions")?

If not, unfortunately the best thing might indeed be
to insert lots of cross-references and have your doc
be a flipbook.

Best of luck!

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address

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

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 &amp; 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 &amp; 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.


References:
Writing procedures that aren't so straightforward: From: Julia Norquist

Previous by Author: Re: Style Guides
Next by Author: Re: Web site legal disclaimers
Previous by Thread: Re: Writing procedures that aren't so straightforward
Next by Thread: RE: Writing procedures that aren't so straightforward


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


Sponsored Ads