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.
> The software I am documenting has a series of windows that share the
same
> main window name but a different subtitle.
>
> Example:
>
> To add a new device, I click Add New Device.
>
> The Add New Device window appears. It has this title:
>
> ADD NEW DEVICE
> Enter a Device Name
>
> I enter a device name and click Next.
>
> The next window that appears has this title:
>
> ADD NEW DEVICE
> IP Address
>
> I enter an IP address and click Next.
>
> The next window has this title:
>
> ADD NEW DEVICE
> Password
>
> and so on.
That's not a window with subwindows -- it's a wizard. The "subwindows"
are the steps of the wizard.
> The subtitles are not parallel, which is one bit of sloppiness, but we
have
> no control over this software and won't be able to change it.
>
> I need to refer to one of these sub-windows. I am not sure whether to
say
> "Enter the IP address in the "IP Address" sub-window of the "Add New
> Device" window, or what.
No, you don't. If your users need a lot of hand-holding (like being told
what an IP address is), or the wizard has steps for which you must
provide additional information (like how to decide what choices to
make), do something like this:
1. Click Add New Device.
The Add New Device wizard appears.
2. Enter a device name and click Next.
3. Enter an IP address and click Next.
4. Enter a password and click Next.
... and so on until:
N. <Do the last step> and click Finish.
The Add New Device wizard closes and <something happens>.
But a well-designed wizard is self-documenting. In most cases, you
should do something like this:
1. Click Add New Device.
The Add New Device wizard appears.
2. Follow the steps. Click Finish when done.
The Add New Device wizard closes and <something happens>.
HTH!
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
