Re: Documentation there really such a creature?

Subject: Re: Documentation there really such a creature?
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 17 May 2006 16:11:12 -0700

j_goldstein -at- juno -dot- com wrote:

Hi all,
I have the interesting opportunity to take on the role of "Documentation Architect"
> (or, as my company calls it...Staff Technical Writer). I'm trying to figure out
> just what this job should/could be. There is a job description, but it's kind
of vague. So, just out of curiousity, if you were appointed your group's "Documentation Architect," how would you define this job...or what would YOU do if you had such
> an exalted (or pretentious?) title?

Well, the first thing I would do is find out whether they really
intend this position to be one of establishing a documentation
architecture or whether this is just a job title that someone
made up to give their technical writers more cred with the
engineers. (For example, when I worked with HP on the COSE
project, I discovered that their writers were called "Information
Product Engineers" in the probably forlorn hope that they would
be taken more seriously by the actual HP engineers.

Assuming that they *do* mean to establish a documentation
architecture, the next thing I'd do is meet with my manager
and insist that management clarify the "vague" job description
so I'd know what was expected of me.

This title could mean anything from establishing someone to
come up with an overall structure for your entire documentation
set to being the person people come to when they want to know
whether to use a Note or a Caution :->

-- Janice

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!.
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Documentation there really such a creature?: From: j_goldstein -at- juno -dot- com

Previous by Author: Re: More Friday Fun: Archie Bunker-style mangled expressions
Next by Author: Re: Index/TOC Needed in HTML &/or Browser-Based Help?
Previous by Thread: Re: Documentation there really such a creature?
Next by Thread: Re: Documentation there really such a creature?

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

Sponsored Ads