Coordinating Field Defs and Procedural Info

Subject: Coordinating Field Defs and Procedural Info
From: "Hickling, Lisa (TOR)" <lhickling -at- Express-Scripts -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 6 Nov 2006 09:25:48 -0600

Tech Scribes! I just gotta know what you think...what is your preference
for coordinating field definitions and procedures in user docs?

Do you describe fields directly in procedures as in "Enter the number of
units suggested by the XYW widgets in the _XYZ Amount_ field"-then
provide no further field descriptions as reference elsewhere in


Do you provide a detailed description of fields in a central location
either per subject heading or perhaps in an appendix-then follow through
in procedures with an expedient "Enter an _XYZ Amount_" or "Enter a
value in the _XYZ Amount_ field", providing a hyperlink from the
procedure page to the field descriptions?

Me, I like to keep procedures thin allowing for copious notes and
cautions on screen behaviour in between if necessary, so, I'm all for
the latter but I recognize that many others are more inclined to the
former. This question assumes that the writer knows his/her audience
and consequently either approach would be equally appropriate.

So! What do you do?

Lisa H.
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits

This email, its electronic document attachments, and the contents of its website linkages may contain confidential health information. This information is intended solely for use by the individual or entity to whom it is addressed. If you have received this information in error, please notify the sender immediately and arrange for the prompt destruction of the material and any accompanying attachments.

******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et dentaires

Ce courriel ainsi que tout document y etant joint de meme que le contenu des liens vers des sites Web peuvent reunir des renseignements confidentiels sur la sante. Cette information s'adresse uniquement a l'usager ou a l'organisation auxquels elle est destinee. Si vous avez recu ce message par erreur, veuillez en aviser l'expediteur immediatement et proceder a la suppression du document et des fichiers joints sans tarder.


WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Previous by Author: RE: From Technical Writing to Marketing
Next by Author: RE: Coordinating Field Defs and Procedural Info
Previous by Thread: Tools: Protect your cell phone
Next by Thread: RE: Coordinating Field Defs and Procedural Info

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

Sponsored Ads