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: Technical writing in a higher ed environment From:"Wendy Cunningham" <wcunning -at- pct -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 19 Mar 2004 21:41:08 -0500
Oops...too much wine and a very long week, I suppose. Correction for
second sentence below: "I really didn't mean CONSISTENCY above all
Staff Development Specialist/Technical Writer
Pennsylvania College of Technology
One College Avenue
Williamsport PA 17701
>>> Wendy Cunningham 03/19/04 9:36 PM >>>
I guess I should have remembered how literal technical writers are
(myself included). I really didn't mean "clarity above all else." Of
course the meaning and clarity come first (assumed we all agreed on that
point). I guess I overstated my case. I meant only to say that
consistency, even at the sentence level, is very important. Keep in
mind that the example I gave was just that--an example, certainly not
the only problem I have with AP. Admittedly, 'style' is as much about
personal preference as anything else.
RE the statement about "consistent documentation across all internal
documentation"... that's really not the situation. I'm the only person
really churning out "documentation"; most other content coming out of
the institution is of a marking/public relations nature. I don't think
anyone much cares what style I use for internal documentation. But,
since I'm providing some of the information via the Web, it is seen as
'publicly accessible.' Hense the need to comply with AP.
Sheesh... thought I was asking for support, perspective, and experience.
Instead I get a lashing... <grin>...
I'm going to have to disagree with you on this one (I know it's
Friday...sorry). You say that "Technical writers are trained to honor
consistency above all else." What I was taught to be most important is
clarity and effectiveness in the content. ...
Also, if we're looking at consistency, there is a valid argument to be
made for having consistent documentation across all internal
ROBOHELP X5 - ALL NEW VERSION. Now with Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!
Now is the best time to buy - special end of month promos, including:
$100 mail-in rebate; Free online orientation on content management
functionality; Huge savings on support and future product releases;
PLUS Great discounts on RoboHelp training. OFFER EXPIRES March 31!
Call 1-800-358-9370 or visit: http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.