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.
My Style Guide, like my Standard Terminology list and glossary, was
the result of lists that I started keeping mostly for myself. It took
them several months to evolve from their (digital) chicken-scratch
beginnings into something vaguely resembling documents that I was
willing to share with the team. I'd been here probably 5-6 months
before I felt like I had developed the sort of relationship with my
team where I could announce that we had a Style Guide.
I started with the Microsoft Manual of Style (because it is readily
available, can be found in stock on the shelves of my local Barnes and
Nobles, and comes with a CD containing a PDF version I could post on
our intranet) and then created a Wiki page where I have listed:
1 - Our Company trademarks
2 - Third party trademarks (Microsoft, Oracle, etc.) and links to
their legal pages listing trademarks
3 - Places where we differ from MMS (because I don't always agree with
4 - Common style problems that I've observed in our doc or UI (even if
they appear in MMS)
Having it on our Wiki makes it easy for me to reference and make the
occasional update. Because unless you're an editor, your Style Guide
will be lucky if it gets a couple minutes of attention here and there.
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-