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 Guides From:Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM> To:Heather Anderson <Heather -dot- Anderson -at- cubrc -dot- org> Date:Wed, 17 Feb 2010 15:54:33 +1100
On 17/02/10 03:43 AM, Heather Anderson wrote:
> Good morning everyone!
>
> I have been tasked to create a style guide for my company.
>
> I was curious if people used them or if they simply used the Chicago Manual of Style for their documentation?
>
> I was hoping to make a simple, quick style guide that covered fonts, formats, and template usage.
>
> Does anyone have any examples or any other information I should include? I am not sure if I should create a usage section with frequently misused words.
>
> I've used style guides in the past, but this is my first time creating them.
>
You might be interested in a best practices guide
booklet called "Developing a Corporate Style Guide":
***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-