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.
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.
I could also call it the "Add New Device/IP Address" window, but I hate slashes. They obscure the relationship.
What would you call it? I would call it lousy UI design, but that's another discussion . . .
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-