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:suggestions for documenting unlabeled fields From:Leslie Johnson <custcomm -at- CADVISION -dot- COM> Date:Thu, 26 Aug 1999 17:19:56 -0600
Michael Simoni wrote: "How do I refer to these unlabeled controls in
procedures and reference
materials? Any ideas?"
Michael, we run into that frequently, and in many cases, the developers
don't see the problem. We typically tell them that we're going to name the
unlabeled whatever-it-is for the purposes of the documentation. We name it
ourselves (ie. "the Widget Start button"), and then wait for the fall-out
from the developers. Once the smoke clears, we usually have a pretty good
name for whatever it is, even if the name doesn't appear in the
window/dialog/whatever.
We've found that this strategy (for want of a better word) needs a screen
capture with call-outs so that users understand what we mean when we talk
about "the Widget Start button".
