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: Other Style Guides From:jsokohl -at- CAMPBELLSOFT -dot- COM Date:Thu, 17 Apr 1997 09:20:25 -0500
Jane Bergen wrote:
>So, are you saying you DID publish a style guide or you're GOING TO
>publish a style guide? I think we'd all welcome an alternative to the
>Microsoft Manual of Style, but I have never seen one that speaks to
>software documentation as well.
I have owned "Read Me First: A Style Guide for the Computer Industry"
(SunSoft Press/Prentice Hall; ISBN 0-13-455347-0) since seeing it at
last year's STC conference. It's a great book! Takes a topic approach
vs. a glossary approach. Chapters include:
UNDERSTANDING STYLE
WORKIGN WITH AN EDITOR
WORKING WITH ILLUSTRATIONS
WRITING FOR AN INTERNATIONAL AUDIENCE
LEGAL GUIDELINES
MECHANICS OF WRITING
TECHNICAL ABBREVIATIONS, ACRONYMS, AND UNITS OF MEASUREMENT
CONSTRUCTING TEXT
INDEXING
RECOMMENDED READING
DEVELOPING A PUBLICATIONS DEPARTMENT
CHECKLISTS AND FORMS
In addition, the CD that comes with the book contains the entire book
contents in FrameViewer(R) and HTML format. Plus, it contains
FrameMaker(R) templates that were used.
I use both MS Manual of and this book. They meet different needs; I
definitely have dog-eared my Read Me First!
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html