Re: Other Style Guides

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!

joe
Joe Sokohl
Mgr. of Documentation
Campbell Software, Inc.
http://www.campbellsoft.com

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


Previous by Author: Any tips on using Front Page for docs that will be printed?
Next by Author: Re: Terminology for Windows 95/MS Office 97
Previous by Thread: Re: Speed reading
Next by Thread: Re: Other Style Guides


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads