Field definitions

Subject: Field definitions
From: "Allen, Emily" <emily -dot- allen -at- teldta -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 3 Jun 2004 13:02:27 -0500


Hi,

I'm just curious about how people document fields that are not used within
procedures.

Example:
We generally like to list the field name and a description of the field when
users must enter data into that field. In the past, we have also included
field names that are not used in our company or for a particular SAP
transaction. Recently, I've been thinking about not including these unused
fields so that users just get the information that they need and to
eliminate unnecessary information. Any thoughts?

Thank you!

Emily Allen | Documentation Specialist
Telephone and Data Systems, Inc.
8401 Greenway Blvd | Suite 230 | Middleton, WI 53562
T: 608.664.8249
emily -dot- allen -at- teldta -dot- com | www.teldta.com


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

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: What to use: Buttons, Function Keys, or Both?
Next by Author: How to document column names?
Previous by Thread: RE: Citrix: are you using it for technical writing or in general, thoughts?
Next by Thread: Field definitions?


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


Sponsored Ads