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 Manual From:Janice Gelb <janiceg -at- marvin -dot- eng -dot- sun -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 27 Mar 2001 09:10:49 -0800 (PST)
In article ORG -at- lists -dot- raycomm -dot- com, tekritelist -at- hotmail -dot- com ("Arthur Schweke") writes:
>I am designing a style manual for our department. It is not to be an
>elaborate document. Questions of grammar and styles, such as footnotes and
>cross references will be referred to the Chicago Manual of Style. Computer
>terms will be referred to the Microsoft Manual of Style for Technical
>Publications.
>
>Our department produces on-line help and hard-copy documentation. The
>hard-copy documentation includes:
>Release notes
>Procedures
>User's Guides
>
>How would you design this manual? What elements would you include?
>
You may want to look at the tables of contents for some
industry-specific style manuals (such as _Read Me First: A
Style Guide for the Computer Industry_).
These could point you to possible topics to include. You may
also want to think about supplying a book like that for a baseline,
and then just produce a supplement specific to your company (such
as terms specific to your industry, style for your manuals that
differs from industry standard, and the like).
If you're planning to attend the STC conference in Chicago,
you may want to look for sessions on developing style guides.
I'll be speaking on this topic during the Editing Progression
on Tuesday afternoon, and I think there are also a couple of
other sessions related to this topic.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
