RE: Writing procedures

Subject: RE: Writing procedures
From: "Gordon McLean" <gordon -dot- mclean -at- sword-ciboodle -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 16 Jul 2009 11:43:14 +0100

No you don't NEED to document all the fields in a screen, you CAN only
document the fields that the user will interact with as they complete the
task they are currently working on.

Depending on your audience, if you can be certain that some headings do not
need explanation then you CAN choose not to describe them.

Background processes, I'm presuming to be additional things the user COULD
do with the application, I'd leave to another section. If it's not in the
'flow' of what the user is doing they'll only distract them from their
current task.

No real answers to any of this, of course, depends on your audience needs,
any other existing documentation that follows a specific pattern, and
whether or not there is a requirement to document every single field (I hope
not!)

But I hope this helps,

Gordon


-----Original Message-----
Subject: Writing procedures

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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

__________________________________________________________________________________
Sword Ciboodle is the trading name of ciboodle Limited (a company
registered in Scotland with registered number SC143434 and whose
registered office is at India of Inchinnan, Renfrewshire, UK,
PA4 9LH) which is part of the Sword Group of companies.

This email (and any attachments) is intended for the named
recipient(s) and is private and confidential. If it is not for you,
please inform us and then delete it. If you are not the intended
recipient(s), the use, disclosure, copying or distribution of any
information contained within this email is prohibited. Messages to
and from us may be monitored. If the content is not about the
business of the Sword Group then the message is neither from nor
sanctioned by us.

Internet communications are not secure. You should scan this
message and any attachments for viruses. Under no circumstances
do we accept liability for any loss or damage which may result from
your receipt of this email or any attachment.
__________________________________________________________________________________

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

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: Importing DITA into RoboHelp
Next by Author: RE: 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


Sponsored Ads