Friday is my semi-official "don't break anything" day; which means I
don't start any new projects and I spend as much time as possible
writing documentation for things I worked on during the rest of the
week.

We use our configuration management and source-control systems for
"automatic" documentation. When this needs more explanation we put it
into an IT-department Wiki. If those documents need to be seen outside
the department we put them into the company's CMS.

Having a new guy is a great motivation for writing documentation.
Especially if they work in a different location or have different
hours. It's often easier to write documentation when I need to explain
it anyway.

On Tue, Mar 2, 2010 at 9:55 AM, Christopher A Manly <c...@cornell.edu> wrote:
> The times that I have been best about documenting things, and building the
> habits to do so, are when I am documenting myself out of a part of a job
> that I don't want to have to do anymore.  I think that "make the new guy
> write docs" doesn't work because the new guy doesn't know the answers.  He
> needs the docs to be written for him.
>
> On Mar 1, 2010, at 7:56 PM, <josh+s...@eldertimes.us>
> <josh+s...@eldertimes.us> wrote:
>
> So, I suspect like at least a few of you, I suck at documenting what
> I've done.  Unless I make a conscious effort to do it as I go along,
> it often doesn't get, as the next fire takes priority.
>
-- 
Perfection is just a word I use occasionally with mustard.
--Atom Powers--

_______________________________________________
Discuss mailing list
Discuss@lopsa.org
http://lopsa.org/cgi-bin/mailman/listinfo/discuss
This list provided by the League of Professional System Administrators
 http://lopsa.org/

Reply via email to