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.
> Wasn't it just last week that half the posters on the list were
> belittling designers for worrying about a fractional different in font
> size?
>
> How is worrying about whether to use a hyphen, a space, or no space any
> better?
>
> I'm sorry, but I just can't see how taking a stand on the matter affects
> the useful of your docs one way or the other....It's a small gesture
> that can make a reviewer feel better, and I simply can't get worked up
> about such matters one way or the other.
Exactly, Bruce! When I'm figuring out whether/how to incorporate feedback from
reviewers, I have a litmus test question that I ask: "Will incorporating this
feedback make the documentation harder to understand?" If the answer is no, I
will always, always, *always* incorporate the feedback. It's hard enough to get
feedback out of certain developers, so the last thing that I want to do is
refuse to go with the way they want to spell things or say things if there
isn't a compelling reason to do so.
In a worst-case scenario, consider using a variable for the word, and then if
you decide later that it should be spelled differently, you can just change the
variable.
ANNOUNCING ROBOHELP STUDIO
Create professional Help systems that feature interactive tutorials and
demos with all new RoboHelp Studio. More at http://www.ehelp.com/techwr-l2
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
---
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.
