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: Style Guide Elements? From:Jill R Shapiro <jsbz+ -at- ANDREW -dot- CMU -dot- EDU> Date:Fri, 1 Oct 1993 12:11:37 -0400
I am a tech writer for a software development group. I'm currently in
the process of writing a style guide for our organization. Here is my
table of contents listing in its very rough form (pretty much a brain
dump at this point). Hope it's helpful. Also,I'd appreciate input.
Actually, the part I've found most helpful thus far is the word list in
chapter 6. I'd say that such a list is a necessity. (Sure saves time in
About This Guide
What are style guidelines?
Why do you need style guidelines?
What's in this guide
Conventions used in this guide
CHAPTER 1 Using Templates
CHAPTER 2 Organizing the Document
Widows and orphans
Illustrations and graphs
CHAPTER 3 Addressing the Reader
Primary and secondary readers
CHAPTER 4 Building Effective Sentences
CHAPTER 5 Spelling and Punctuating
Abreviations and acronyms
Brackets and parentheses
Numbers and bullets
Periods and commas
Apostrophes and quotation marks
Titles and capitalization
Dates and times
CHAPTER 6 Using Tricky Words (an alphabetical listing)