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:Style Guide Sum & Followup From:Dan Lupo <Dan_Lupo -at- CCMAIL -dot- US -dot- DELL -dot- COM> Date:Wed, 16 Aug 1995 16:59:30 CST
Friends,
Because about a dozen people asked me to summarize, here are the results of
my request for information/sources/tips/war stories regarding style guides.
RESULTS
1. One person sent me a guide he created, along with the MSWord
templates he developed -- excellent stuff. Many, many thanks!
2. Another answered my specific questions (preceded by >s) as follows:
> Thanks for the tip and encouragement. I have some questions:
>
> 1. how did you come up the the list of ALL THE THINGS that one has
> to worry about in terms of style?
Take a thorough look, and categorize, all existing and planned
literature, signage, print material (letterheads, forms, etc).
>
> 2. did you do separate style guides for online and hardcopy?
I haven't had the opportunity to do an online style guide, but if I did,
yes, absolutely two separate guides
>
> 3. did you separate language/conventions from visual issues?
Yes.
>
> 4. any other pitfalls you can remember from your efforts?
Without follow-up backed by senior management, and/or without automated
styles, the effort will fail (unless it's a very small company with very
little staff turnover -- in which case there's usually no money or need
for a style guide).
................end of excerpt.........................
3. Another responder supplied this citations:
Tarutz, Judith. 1992. Technical Editing. Addison-Wesley.
ISBN 0-201-56356-8.
4. One colleague suggested I check the web, specifically Comserv.
Many thanks to all.
NEW REQUEST
Anybody know the urls or ftp sites of style guides on the web -- not
html guides for web pages, but for in-house pubs? For example, I found
Apple's guide (ftp.info.apple.com) at http://www.info.apple.com/cgi-bin/lister-pl?Apple.Support.Area/Developer_Se
rvices/Technical_Documentation/Publication_Guides/