Re: Coordinating Field Defs and Procedural Info
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?
I would always mention the field name. Whether
I'd link to more about the widgets and the way
to determine the value would depend on the nature
and location of the procedure. If the above
step was in the middle of a procedure on a
screen or dialog box where the field location
is clear and the procedure has just followed
an explanation of the widgets that provide
the information, then I wouldn't provide any
further information or links.
If the description of the widgets that provide the
value for the field is not located near the procedure,
then I'd probably add a sentence under the step
that said "For more information about how to
determine the number of units for XYZ, see _link_."
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
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! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.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/techwhirl/ for more resources and info.
RE: Coordinating Field Defs and Procedural Info: From: Hickling, Lisa (TOR)
Previous by Author:
Re: Representing variables -- thanks!
Next by Author: Re: Naming NAME fields (was RE: Coordinating Field Defs and Procedura l Info
Previous by Thread: RE: Coordinating Field Defs and Procedural Info
Next by Thread: RE: Coordinating Field Defs and Procedural Info
Search our Technical Writing Archives & Magazine