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: GUI documentation From:Jyoti R <jyoti -at- INDIA -dot- ASPECTDV -dot- COM> Date:Wed, 23 Jul 1997 11:43:59 +0100
Hi Julie,
For all GUI guides in my office, we follow the following rules:
1) Familiarize them with the main screen or the opening one, the
elements in it like the toolbars, icons, etc. Once you do this upfront
you don't need to repeat this again in the document. Except for, when
explaining a new feature you can just show the icon alongside the text.
2) When you are explaining a GUI feature, you need to show them atleast
two important functions of the feature with the screens.
3) There will be many screens which are common to the whole software.
This you could put the screen shot once or twice and then just mention
it throughout the document.
I feel the users look for more screen shots for a GUI based product.
Hope the above is quite satisfying!
--
***********************************************************************
Jyoti Ramchandra
Aspect Development India Pvt. Ltd
Phone : 91-80-2217990/1/2/3 - Extn : 213
Fax : 91-80-224 1961
***********************************************************************
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
