Re: document your job?

Subject: Re: document your job?
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: Editor in Chief <editorialstandards -at- gmail -dot- com>
Date: Wed, 11 Jul 2012 16:08:18 -0700

Is there still any such thing as a "common techwriter work environment
anymore? I haven't had two jobs that had all that much in common in the
past 20 years.

In an ISO environment, documenting processes and work instructions is a
requirement, and even in the absence of ISO it is still good business
practice.

Note that documenting processes and work instruction is NOT the same thing
as documenting your job. It is one thing to write a list of instructions
for tasks such as how to configure and use a VM, how to build a new
document using the company template, etc., that would enable someone with
your skills and experience to pick up where you left off if the event that
proverbial bus ever connects with the wrong part of your body, but you
cannot provide step-by-step instructions for your skills and experience.
An instruction step that says, "Edit draft to the requirements of the MS
Manual of Style" is not the same thing as training an editor. Even in the
ISO environment, work instructions only apply to step-by-step tasks and not
to functions requiring educated judgement and skills.

If you are not doing anything that requires educated judgement and skills,
then you may have something to worry about from having your work
instructions documented....

Gene Kim-Eng



On Wed, Jul 11, 2012 at 12:32 PM, Editor in Chief <
editorialstandards -at- gmail -dot- com> wrote:

> Does the above describe a fairly common techwriter work environment, today?
>
> Is there a good reason, from the writer perspective, to pull all the
> documentation
> for such an environment together in one place, one document? Without the
> carrot/stick of ISO preparation looming?
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
document your job?: From: Editor in Chief

Previous by Author: Re: Owner's Manual mistake
Next by Author: Re: document your job?
Previous by Thread: RE: document your job?
Next by Thread: RE: document your job?


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

Sponsored Ads


Sponsored Ads