Choosing a base style guide

Subject: Choosing a base style guide
From: Kelly Smith <KellyMJSmith -at- gmail -dot- com>
To: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 16 Oct 2014 06:28:10 -0400

Hi all,

I've started a new job where tech writing is my only duty. In the past I've
always had other roles (QA, business analysis etc.) I'm working with the
other new tech writer (we both started last Monday in different branches of
the IT department) and we're trying to decide on a base style guide.

We'll be writing docs for disaster recovery, test planning, FAQs, and
business processes among other things. This company has never had tech
writers before, so we kind of have free rein.

My question is, does anyone have strong opinions about a good, general
style guide? We are leaning roward CMS because we're both familiar with it,
but wondered if something like the Microsoft manual of style would be
better suited to the more technical documents.

I told her I'd ask here. If there's no clear consensus, we'll likely use
CMS and then create an internal style sheet for things not covered in it.

Thanks!

Kelly Smith

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Meeting minutes for an HR project
Next by Author: Re: Choosing a base style guide
Previous by Thread: RE: Meeting minutes for an HR project
Next by Thread: Re: Choosing a base style guide


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

Sponsored Ads


Sponsored Ads