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.
On Thu, Mar 11, 2010 at 12:10 PM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> I have to disagree with devoting time to immediately creating a company-specific style guide.
> What she needs to do is hit the ground running and show them immediate real productivity.
I agree with Mike's assessment of the situation. I've recently become
the lone tech writer at our office, and while it's tempting to want to
mandate stylistic consistency from the get-go, all this effort is moot
unless we produce something.
That said, I really like the idea of using a wiki-based table to track
style usage decisions as they are made. That way everyone is on board
and has input from the beginning. The only overhead at the beginning
is to set up the content framework on the wiki, which is and should be
subject to change. At the beginning the table will collect more
questions than answers, but at least we can trace back our prior
decisions without having to reference scads of earlier documents.
(Fortunately in my case I'm building on a consistent base established
by my former colleague, so I'm not starting at ground zero. In this
environment it's in my best interest to play with macros and style
sheets to build enterprise-wide efficiencies.)
Tony Chung: Creative Communications
Email: tonyc -at- tonychung -dot- ca * Web: http://tonychung.ca
Skype: tonychung.ca * GTalk/MSN: tonychung -dot- ca -at- gmail -dot- com
Twitter: @techcom * Facebook: http://www.facebook.com/tonychung.ca
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-