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: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
