Re: a question about writing instructions

Subject: Re: a question about writing instructions
From: Becca Price <becca_price -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 6 Feb 2003 06:22:30 -0800 (PST)


arugh! of course, I forgot the most important part...

What do others think aobut this style of writing instructions?
it seems odd to me, but then most of the other places I've
worked have requred much more involved instructions. The stuff
I'm documenting now are (usually) pretty simple to use.

Is this a "new style" of writing that I've not been much exposed
to, or was our house style developed by a lazy writer? (there is
some evidence to that latter comment; most of the manuals I've
inherited are GUI guides rather than what I would consider a
true user's manual)

-becca



--- Dick Margulis <margulis -at- mail -dot- fiam -dot- net> wrote:
> And your question is???
>
> ---------- Original Message ----------------------------------
>
> >I recently started in a new position where the house style is
> to
> >not write out instructions as steps, but rather in narrative
> >form. That is, rather than having step 1, step 2, etc, an
> >instruction might read (under a header like "Using the XYZ
> >Screen"): "To add an item to the data base, enter the
> specific
> >information and press Add. To locate an item already in the
> >database, enter any information you may have, and press
> Search.
> >If more than one item matches your criteria, you will see..."
> >You get the idea.
> >
> >This is a made-up situation; no comments about the design of
> the
> >mythical page or database or use thereof, please! My question
> is
> >strictly about format.
> >


=====
becca -at- di -dot- org (primary address)
What is courage now?
Is it just to go until we're done?
Men may call us heros when they can say we've won
But if we should fail, how then?
What is courage now?
--"Fellowship Going South", by Leslie Fish

__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com

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

Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l


---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: a question about writing instructions
Next by Author: Trend reports
Previous by Thread: Re: a question about writing instructions
Next by Thread: Re: a question about writing instructions


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

Sponsored Ads


Sponsored Ads