RE: Field definitions

Subject: RE: Field definitions
From: "Norcross, Amanda" <Amanda -dot- Norcross -at- kla-tencor -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 3 Jun 2004 11:19:57 -0700


Emily Allen wrote:

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

Our technical writing group handles this by separating the window
descriptions from the procedures. The window descriptions act as reference
material, providing a detailed description of every field, button, etc. in
each window. The procedure tells the user how to perform a task, giving them
just the information they need to know about the window to perform that
task. The window descriptions and procedures are always in separate
chapters/sections, but we always make sure to provide a link between the
procedure and related windows and vice versa.

Amanda


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

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.



Previous by Author: Re: RoboHelp for Word or RoboHelp Office?
Next by Author: re Side note to "Ethics of job-interview testing"
Previous by Thread: RE: Field definitions
Next by Thread: RE: Field definitions


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

Sponsored Ads


Sponsored Ads