TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Documenting visible/invisible fields? From:Janice Gelb <janiceg -at- marvin -dot- eng -dot- sun -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 20 Feb 2002 16:13:16 -0800 (PST)
In article 4A1FB5D47D121747A20CE141655F2245EF2730 -at- vega -dot- selkirkfinancial -dot- com, Hart -at- SelkirkFinancial -dot- com ("Hart, Rowena") writes:
>Hello all,
>
>I'm trying to think of a good way to
>document fields that are visible or
>invisible, depending on the options
>the user selects.
>
>For example: If the user selects Deal A,
>fields that are specific to that type
>of deal are displayed. If the user selects
>Deal B, fields that are specific to that
>type of deal are displayed. Some fields
>may be common to both Deal A and Deal B,
>while other fields are unique.
>
>In the reference manual that I have
>inherited, every field is listed and
>described in detail. Given the changeable
>nature of the interface, how would you
>document the fields?
>
Is this for context-sensitive help or print documentation?
Assuming a print reference manual, I'd recommend having a
section for the common fields first, then the ones specific
to A, then the ones specific to B.
For a user's guide, branching procedures is probably the
best you could do.
*******************************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- eng -dot- sun -dot- com | this message is the return address. http://www.geocities.com/Area51/8018/index.html
"The people who live in a Golden Age usually go around
complaining how yellow everything looks" -- Randall Jarrell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.
