Writing procedures

Subject: Writing procedures
From: "Raj " <uneasysoul -at- rediffmail -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: 16 Jul 2009 06:01:11 -0000

The following are a few basic questions.

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

Also, if the user searches for information, should all the information on that screen be documented, or only those headings that are not self explanatory be described?

Can background processes be described in the procedure itself or as notes?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com/SuperPages/Webcasts/

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

Previous by Author: Re: Red SAVE Button
Next by Author: Re: Aging out was RE: job-hunt weirdness
Previous by Thread: Re: Fortune cookies
Next by Thread: Re: Writing procedures


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

Sponsored Ads


Sponsored Ads