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.
In my new job here at Walter Reed, I've discovered that the
developers' documentation is generally solid and easy to understand,
but it's rife with grammatical errors and inconsistent style usage
that defeats the purpose...things like capitalizing "telepsychiatry"
when referring to the general profession, rather than a particular
department. (Imagine capitalizing "psychiatry" every time you referred
to it in a sentence.)
The primary app developers do not speak English as a first language,
so they often miss contextual cues and best standards, such as using
"he/she" constantly as opposed to "they", or avoiding gender-neutral
I've been pondering whether or not I should create a style guide for
the department to refer to, both to improve their skills and free me
up to concentrate on more creative projects. But I have never done
this before. Is it the right course of action to take, and if it is,
what're some good suggestions or resources I can use in its creation?
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.