RE: Fields arranged as a sentence

["Lisa Wright" <liwright -at- earthlink -dot- net>]

Lindsey,
I've documented any number of query tools over the years and I find the
sentence style arrangement by far the easiest for the user to
understand, whether they are experts or not. In one instance, I actually
discovered that a different arrangement was masking a problem with the
programmed query logic and the tool was consistently returning incorrect
results. Putting the interface into sentence style forced the problem
out in the open. It also made it much easier for the users to understand
how to use the application without help. 

I really think you answered your own question: the sentence style
arrangement communicates the semantics better. Your field style
arrangement isn't going to communicate the nature of the arguments any
better than default prompts will. From an interface perspective, an
organization that better communicates its purpose is the better choice.
Just because your users are experts doesn't mean you shouldn't make it
easy on them. It's great that you've been asked to provide input on the
interface, but I don't think your input should be based on what's easier
for you as a writer. (That said, I do think that processes that are
difficult to document can often highlight problems with the
interface/process.)

Lisa 

-----Original Message-----
On Behalf Of LDurway -at- pav -dot- com
Sent: Tuesday, November 19, 2002 11:27 AM
To: TECHWR-L
Subject: Fields arranged as a sentence


I'm documenting a GUI operation that requires the user to enter several
arguments. The programmer has arranged these fields as a sentence, sort
of a fill-in-the-blanks thingie.  It looks like the following, where the
angle brackets indicate the fields & the type of value that the field
accepts:

If <variable-name> is <less-than/greater-than/equal-to> <number> then
generate <event-type>.

I find this type of style awkward to document.

Question:  Do you consider this sentence style to be a good thing or a
bad thing?  or is a more label-oriented style better?  I'm thining of
proposing a label-oriented style like the following:



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

---
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.