RE: Writing procedures

Subject: RE: Writing procedures
From: "Sarah Blake" <Sarah -dot- Blake -at- microfocus -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 16 Jul 2009 11:48:01 +0100

> Should all the fields in a screen be described in a procedure. Or,
> only the fields that the user types an entry should be documented?

A procedure should only describe the fields the user needs to use for
that procedure. Somewhere, however, there should be reference material
that describes all the fields on that screen, and it should be
relatively easy for the user to find from where they are.


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

Previous by Author: IBM style guide
Next by Author: Docs Easter Eggs spotted in the wild
Previous by Thread: RE: Writing procedures
Next by Thread: Re: Writing procedures

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

Sponsored Ads