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.
> Here is an example. I am writing a step for installation. The wording
> on the dialog box reads, "SET UP READY TOO BEGIN."
> Now, this is obviously bad - very bad. When referencing the dialog box,
> how should I reference it?
> "Click Next on the SET UP READY TOO BEGIN dialog box."
> "Click Next on the Setup Ready to Begin dialog box."
I would assume that this could be fixed at any time (possibly the night
before shipping!), so would use the correct form. Think how embarrassing it
would be if they fixed the dialog title without telling you. :)
Is this a modeless dialog box? If not, then you don't have to refer to its
title at all, since it will be the only applicable dialog box. Then you
Click the Next button in the dialog box
I prefer saying "click the x button" instead of "click x," as that
eliminates potential ambiguity. I also generally speak of controls being
"in" dialog boxes rather than "on" them, as that's a more natural way of
speaking about boxes. Similarly, I'll talk about something being "on" a
menu, rather than "in" it.