Re: Lone Tech Writer

Subject: Re: Lone Tech Writer
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 12 Mar 2010 10:59:52 -0500

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
Microsoft)
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.


--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Re: Lone Tech Writer: From: David Neeley
RE: Lone Tech Writer: From: Heather Anderson
RE: Lone Tech Writer: From: Cardimon, Craig

Previous by Author: Re: Analogy parts
Next by Author: Re: Which would you prefer and why? (Help Tool)
Previous by Thread: RE: Lone Tech Writer
Next by Thread: Congrats, Melissa!


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

Sponsored Ads


Sponsored Ads