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: ANOTHER punctuation question From:Bev Lockhart <bl -at- SEATTLELAB -dot- COM> Date:Thu, 5 Aug 1999 14:02:40 -0700
>Local style question. What's your company style guide say?
I'm constantly developing and changing it. There wasn't one before I
started here two years ago. And I came from a journalism background where
we used the AP or UPI style guides (depending on the paper), so I find it
interesting to look at all the competing style guides for technical writing
out there. There are so many different ways to present this stuff. I just
try to think about it logically.
>Both constructions are common in the industry. However, if your audience is
>used to seeing it one way and is suddenly confronted with another way,
>cause at least some momentary confusion.
I always figure if I'm going to make
>my audience change their habits, I need a better reason than Because I
I totally agree with you there. My goal is to make things as easy and
clear as possible for my readers. Since I'm really a major non-techie
(hey, I don't even know html or Robohelp; I have other people to do that
for me), it's a lot easier for me to pick up on concepts that the brains
around here think are understood and amplify them or clarify them. (You
should see some of the looks I get from these engineers when I go talk to
them about features. I have to remind myself that I'm not stupid, just