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.
Michelle Vina-Baltsas wonders: <<I've read many threads on this
listserv related to the use of "appears" vs. "displays" or "is
displayed". During a meeting yesterday, with my fellow tech writers,
we had a heated discussion about whether we should use "is displayed"
or "displays" when writing a result (For example, "Select the XYZ
button. The EXY dialog box is displayed.")>>
Actually, I prefer "Click the XYZ button to display the EXY dialog
box" or its inverse: "To X, click Y". Simpler and clearer, and you're
not making any predictions about whether the dialog will actually
appear. Sometimes, best intentions notwithstanding, it doesn't.
Also, you don't select buttons: you click them. Only checkboxes and
radio buttons should be selected in a dialog (or items from dropdown
menus). It's an important distinction: selecting something merely
chooses it as a parameter of what happens next, but clicking a button
triggers an immediate action.
<<One writer insisted that the use of "is displayed" should not be
used because it is in the passive voice.>>
Yes, it's passive, and I'll avoid getting into the whole transitive/
intransive verb issue here. Passive voice is not inherently wrong,
particularly since the alternative is to constantly say "the software
then displays..." or similar wording. You can do that too, but
really, there are better solutions.
----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
***Now available*** _Effective onscreen editing_
(http://www.geoff-hart.com/home/onscreen-book.htm)
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-