Re: Writing procedures that aren't so straightforward

Subject: Re: Writing procedures that aren't so straightforward
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 10 May 2007 12:15:17 -0700 (PDT)

I think your solution is to write as intuitively as
possible as you did in this message. I would explain
the situation in a half-paragraph, and then say, "You
will encounter any number of the following," and list
them under unnumbered topic headers to imply a lack of
linearity. You might want to then follow each topic
with a series of Tips or Notes describing interaction
with other options, as in "Note: If procedure A is
also installed, the procedure for modifying C above
will take you to screen B where you will be required
to enter your blood type and bank account number."

Sounds fun!

--- Julia Norquist <julia_norquist -at- yahoo -dot- com> 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.


User Interface design blog
http://user-advocacy.blogspot.com/
Code::Design::UI::Consulting
http://www.dionysius.com/



____________________________________________________________________________________
TV dinner still cooling?
Check out "Tonight's Picks" on Yahoo! TV.
http://tv.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 &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: Anonymous list post (was Re: re Interviewing Tech Writers)
Next by Author: Quality documentation helps software spread
Previous by Thread: 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