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.
Sorry, I wasn't clear in my first message.
This is just a reference manual -- there
are no procedures, just table after table
of field descriptions and technical
background info.
I guess I'm trying to get suggestions
about the best way to present the fields
to users, based on the user's own experience
with the fields.
For example, would you just list all of
the fields in alphabetical order? Would
you include a note along the lines of "This
field is only visible if you select Deal A"?
Or would you say "The following fields are
displayed if you select Deal A:" and then
list the fields?
I was trying to think of it from a user's
perspective. You want help on Deal A so
you go to the reference manual. Would you
be dumbfounded to see lists of fields that
don't apply to Deal A? Or by a note that says
"This field is displayed for Deal A, C, and
F"?
It's all about how the user searches for
information in a reference manual. Hopefully
someone out there has hit this wall before
and can share some their experiences.
Rowena
# -----Original Message-----
# From: Hart, Rowena [mailto:Hart -at- SelkirkFinancial -dot- com]
# Sent: Wednesday, February 20, 2002 3:14 PM
# To: TECHWR-L
# Subject: Documenting visible/invisible fields?
#
#
# 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?
#
# Thanks in advance,
#
# Rowena
#
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
