GUI documentation

[Julie Tholen <julie_tholen -at- CNT -dot- COM>]

I'm finding myself in an interesting situation. I've pretty much decided
which path that I will take, but I would like to hear from others who
have dealt with GUI before.

In my new position I'm tasked with creating both a user manual and a
hardware manual for a new product (which of course is not done yet - but
at least it isn't vaporware!). Coming out of a UNIX world, I haven't had
too much experience with creating GUI documentation. From what I have
seen, the user manuals fall into two camps: first, page after page of
screen captures illustrating what the user is looking at on their tube,
with somewhat explanatory  field text; or second, a starting point
screen capture, with field by field identification and definition.

Both ways seem dissatisfying to me. How do you handle GUI? How much
field definition do you do? Do you specify implication of choices? Do
you provide an overview of a task and then follow the screen-path to its
completion? Do you like to use lots of screen captures or do you leave
that to the training department?

Thanks for your insights!


J.A.E. Tholen
Sr. Technical Writer
CNT, Inc.
612.550.8317
"Life is short: eat dessert first."

 TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
   to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
  Search the archives at http://www.documentation.com/  or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html