Re: Writing procedures?

Subject: Re: Writing procedures?
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 16 Jul 2009 10:13:48 -0700

As Geoff says, if you're documenting a procedure, you shouldn't
include anything irrelevant to the procedure.

If you're writing a general description of a dialog box for some sort
of reference, you should be supplying information that's not on

A prose description of a dialog box or wizard panel that adds nothing
to what users can see for themselves onscreen is uninformative and
degrades the documentation by making the user wade through
uninformative fillter find whatever useful information (if any) is in
the doc. I've inherited docs that consisted entirely of such pointless

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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.

Please move off-topic discussions to the Chat list, at:

Writing procedures: From: Raj
Writing procedures?: From: Geoff Hart

Previous by Author: Re: Microsoft Manual of Style where oh where
Next by Author: Re: job-hunt weirdness
Previous by Thread: Writing procedures?
Next by Thread: Docs Easter Eggs spotted in the wild

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

Sponsored Ads