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.
> > From: McLauchlan, Kevin
> > No style guide?
> > Write one. Then use it to bludgeon anyone who disagrees with you.
> Sounds like somebody is having a Monday (it's Thursday), but I agree
> all of the stuff about infinite lists and which person to use.
> About infinite lists: one instructor I had taught that an infinite
> such as list that ended with "etc.," should be replaced with a finite
> that began with "for example" or "such as" and didn't end with an
I use that form a lot.
Our company style guide frowns on "etc.", "e.g.", and "i.e.", among
other perfectly good bits of usage. But let's not get into the old
death-spiral about "dumbing down". I'll just assume it as a given. :->
> I also have strong aversions to second-person usage in documentation.
> read one help document that began nearly every sentence with "you" and
> contained such statements as "you must..." and "...then you click..."
> annoyed. Why was this document telling me what to do?! So I say,
> "you." Not *you* per se, but the term "you."
I use an explicit "you" sparingly.
I use the implied "you" everywhere.
Step 1: Do this.
Step 2: Do that.
Something else happens.
Step 3: Hold the chicken in your left hand, the book in your right hand,
and the knife in your teeth, while muttering the incantation and turning
widdershins (ensure that you do not cross the pentagram boundary while
Every instruction to do something is second-person, with the implied
Step 4: You really gotta see this.
OK, that could be either a command (an instruction) or a simple
declarative, depending on tone and situation, but I digress.
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
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-