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:guidelines for a style guide From:Gayle Hoffman <Gayle_Hoffman -at- SGSGROUP -dot- COM> Date:Tue, 22 Sep 1998 13:35:44 +0200
I am trying to put together a style guide for a small group of TW to use
and that will provide guidelines for the editting/reviewing process. Does
anyone have any ideas on how to define "wordiness" or "humour" or
"procedure/instructions" vs. "descriptions" in a style guide that will
clearly explain what is acceptable or what the limitations are for the
documentation written by the members of the group? We are using the
Information Mapping approach that breaks information up into blocks or
chunks of related information. For example, while I am reviewing the other
TWs' work, I find the chunks too wordy and to avoid this in the future I
want to define this in the Style Guide so that my comments do not come
across as subjective but objective and constructive remarks.
Thanks for your time and your input on this topic.