Re: First Technical Writer

Subject: Re: First Technical Writer
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Mar 2010 12:39:26 -0800

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
Cell: +1-604-710-5164
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-

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: First Technical Writer: From: Richard Melanson
RE: First Technical Writer: From: Keith Hood
Re: First Technical Writer: From: Chris Morton
Re: First Technical Writer: From: Mike Starr

Previous by Author: Re: show a PDF pop-up based on the viewer's zoom value ?
Next by Author: Re: Address this. . .
Previous by Thread: Re: First Technical Writer
Next by Thread: Re: First Technical Writer


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

Sponsored Ads


Sponsored Ads