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: my bad displays habit From:Mike Starr <mike -at- writestarr -dot- com> To:suzchiles -at- gmail -dot- com Date:Tue, 02 Mar 2010 11:06:39 -0600
Click the *Settings* button. <program name> displays an *Edit Settings* dialog box similar to the one shown here.
In spite of the collective received wisdom that my approach is wrong on so many levels, I'll continue to use it unless a corporate style guide expressly dictates otherwise. I like to make sure the user knows exactly what the result of his/her action will be. Yes, this may be tedious for both the writer and the reader but I prefer to think the clarity of this approach adds enough value to outweigh the tedium.
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
Suzanne Chiles wrote:
> I have fallen into the bad habit, when writing task topics, of following the
> instructions with sentences like "The Edit Settings window displays." I know
> this is bad usage, but all other versions of this type of information seem
> awkward and overly-thought-out. I think it goes back to a manager I had many
> years ago who wouldn't let us say "appears" because she thought it made it
> sound like the results of a magic spell.
> Anyway, I am open to suggestions.
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-