Re: Writing procedures

Subject: Re: Writing procedures
From: Anuj Kapoor <anuj -dot- anujkapoor -at- gmail -dot- com>
To: Raj <uneasysoul -at- rediffmail -dot- com>
Date: Thu, 16 Jul 2009 16:09:52 +0530

Hi Raj,

It depends upon the application as to whether the fields are important
enough to be provided information. Usually, when we are buing a User
Guide, then we describe all the fields irrelevant of the fact that the
user will type it or not.

Cheers,
Anuj

On Thu, Jul 16, 2009 at 11:31 AM, Raj<uneasysoul -at- rediffmail -dot- com> wrote:
> 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 anuj -dot- anujkapoor -at- gmail -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/anuj.anujkapoor%40gmail.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
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


References:
Writing procedures: From: Raj

Previous by Author: Re: Suggestions for free/cheap/Open Source documentation for Web Site & PDF?
Next by Author: A Review of: DITA 101 – Fundamentals of DITA for Authors and Managers
Previous by Thread: Writing procedures
Next by Thread: RE: Writing procedures


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

Sponsored Ads


Sponsored Ads