[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Silly but important to me - another twist

Subject: Re: Silly but important to me - another twist
From: dmbrown -at- brown-inc -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 02 Sep 2004 09:25:48 -0700


eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com wrote:

...Most
supporting text in procedures in my experience belongs in a note either before of after the step. Before the step if the information is required to perform the step and after the step if the information describes the result or is not otherwise critical to the action.

One problem with this approach is that it's impossible to tell at a glance whether a given note is associated with the step it follows or the step it proceeds:

1. Do this.

Note: Something unimportant about step 1.

2. Do that.

Note: Something important about step 3.

3. Do the other.

Most people will tend to read the steps and ignore everything else.

Of course, getting people to *read* the information we provide is a different discussion altogether.

--David

=========================================================================

A V A I L A B L E N O W ! http://www.html-indexer.com

HTML Indexer is still the easiest way to create and maintain real indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.





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

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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:

References:
Re: Silly but important to me - another twist: From: eric . dunn

Previous by Author: Re: Index with links
Next by Author: Re: Interoffice Relations/Work Productivity Dilemma
Previous by Thread: Re: Silly but important to me - another twist
Next by Thread: Re: Silly but important to me - another twist

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads