Re: Go to? Switch to?

Subject: Re: Go to? Switch to?
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 30 Apr 2007 10:49:10 +1000

Vlada Goldin wrote:
> I think you're right about the importance of "whys" but I'd put them in an introductory paragraph rather than within operating instructions. IMO, wordy explanations distract users from the actual procedure flow. I guess that those who want to perform the procedure, know why they do this. They just don't know how. If they know neither why nor how, they can read the entire section from the beginning and get the explanations before getting to the instructions.

They don't have to be wordy:

* To close the command window, type exit.

* To change to the program directory, type
cd C:\Program Files\Happytime\Candy cane\Server 111\

-- 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.

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:

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

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 for more resources and info.

RE: Go to? Switch to?: From: Vlada Goldin

Previous by Author: Re: Problem Co-worker
Next by Author: RE: Happy to be a Tech Writer?
Previous by Thread: RE: Go to? Switch to?
Next by Thread: RE: Go to? Switch to?

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

Sponsored Ads