Re: document your job?

Subject: Re: document your job?
From: Editor in Chief <editorialstandards -at- gmail -dot- com>
To: "Porrello, Leonard" <lporrello -at- illumina -dot- com>
Date: Wed, 11 Jul 2012 17:22:59 -0400

As other-kevin sometimes says: "bingo".

On Wed, Jul 11, 2012 at 5:18 PM, Porrello, Leonard
<lporrello -at- illumina -dot- com>wrote:

> Documenting what you do for your own benefit is not a bad idea. From an
> ethical perspective, however, it is not as black and white as Dan suggests.
> It clearly becomes a question of professional ethics only when Kevin is
> tasked with documenting what he does. Otherwise, you need to weigh the
> opportunity cost of documenting the job (against using that time to write
> and improve documentation).
>
> It is also not a question of doing it out of gratitude for 20+ years of
> employment. Unless Kevin's employer has kept him on for charitable reasons,
> it is safe to assume that the relationship has been mutually beneficial.
>
>
> -----Original Message-----
> From: techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com [mailto:
> techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of
> Dan Goldstein
> Sent: Wednesday, July 11, 2012 1:57 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: document your job?
>
> I consider it part of my professional ethics to leave clear documentation
> for those who will follow. Most of us have picked up a project where
> someone unnecessarily left us a mystery... or a mess.
>
> To be clear, I'm not just talking about predecessors and successors. Ten
> years from now, the poor schmuck who has to figure out what I was doing
> this week might well be me.
>
> Happy Wednesday!
>
> - Dan Goldstein
>
> P.S.: I try to avoid the "hit-by-a-truck" scenario. Instead, I always say
> to my colleagues whose work I document: "If you were to win the lottery
> tomorrow and move to Hawaii, what would the rest of us need to know?"
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
RE: document your job?: From: Dan Goldstein
RE: document your job?: From: McLauchlan, Kevin
RE: document your job?: From: Dan Goldstein
RE: document your job?: From: Porrello, Leonard

Previous by Author: Re: document your job?
Next by Author: Re: IS or ARE
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