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: dialog versus dialog box revisited From:Samuel -dot- Beard -at- tdcj -dot- state -dot- tx -dot- us To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 27 Jan 2003 13:27:54 -0600
Hey Dick,
Dick Margulis wrote:
It isn't a matter of right or wrong. It's a matter of style. I think you
are using too many quotes, but if you are using them in a consistent way
and abiding by whatever style guide you use, then who am I to complain?
Mayhaps some clarification is in order here. The enclosing set of quotes
on each of my examples only indicated a phrase, NOT what is actually
contained in the documentation. Thus, to use your example, mine would've
been more like ... in the "Open" dialog box.... or ... Click OK.... Another
way I've seen and used before is to put the actual command, or name of the
item, in bold. Thus: ... in the <bold>Open</bold> dialog box... or ...
Click <bold>OK</bold>.... The idea is to make it somewhat high-level for
those that are familiar with the instructions and only need a quick
reminder, while still providing for those that need more details when
following the instructions.
Hope that clears it up a bit.
Sam
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
