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.
RE: What do you guys think of STCs new definition for technicalwriter?
Subject:RE: What do you guys think of STCs new definition for technicalwriter? From:"Bonnie Granat" <bgranat -at- granatedit -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 23 May 2008 16:06:04 -0400
Needs a comma before "including," but I think the principles of good
technical writing ought to be brought seriously to bear on that definition
Mike. For example: "A technical communicator creates communication .. " --
would you accept something like that in a customer-facing document?
I also think that commenting on the quality in a definition is not good.
Would a definition of a physician say: "Ensures people become healthy..."?
No, of course not. So saying "A technical communicator creates communication
that is clear, concise, comprehensive, accurate, correct, accessible,
accurate, and ..." is like saying "Ensures people become healthy..." --
which is unacceptable.
Question to myself: "Why are you helping with a definition whose term you
think is silly?"
> -----Original Message-----
> From:
> techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l
> .com] On Behalf Of Mike Starr
> Sent: Friday, May 23, 2008 10:12 AM
> To: Borowik, Kristy
> Cc: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Re: What do you guys think of STCs new definition
> for technicalwriter?
>
> Yesterday, in another thread, Sean Brierly came up with this
> suggestion:
>
> Sean Brierley wrote:
> > A technical communicator creates communication that is
> clear, concise,
> > comprehensive, accurate, correct, accessible, accurate, and
> > professional, using a variety of methods, tools, and technologies,
> > that can include writing, illustration, photography, video,
> and sound,
> > for a variety of static and dynamic deliverables, including print
> > media and online media.
>
> I then worked it over and came up with this:
>
> Technical communicators create a variety of print and online
> documents that are clear, concise, comprehensive, accurate,
> correct, accessible, and professional. Typical deliverables
> include manuals, online documentation, proposals, policies
> and procedures, and websites. Technical communicators work in
> all types of businesses and industries around the world and
> use a variety of methods, tools, and technologies including
> writing, illustration, graphic design, photography, video, and sound.
>
> Incidentally, I'm not a proponent of brevity at all costs nor
> am I inclined toward packaging the whole thing into a single
> sentence. Word tells me this paragraph contains 63 words. I
> don't think that's too much.
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-