Great Circle Associates Majordomo-Workers
(August 1998)
 

Indexed By Date: [Previous] [Next] Indexed By Thread: [Previous] [Next]

Subject: Re: admin_commands, take two
From: Jason L Tibbitts III <tibbs @ hpc . uh . edu>
Date: 24 Aug 1998 12:32:08 -0500
To: "Roger B.A. Klorese" <rogerk @ QueerNet . ORG>
Cc: "William R. Dickson -- System Administration" <wdickson @ nwnexus . net>, majordomo-workers @ GreatCircle . COM
In-reply-to: "Roger B.A. Klorese"'s message of "Sun, 23 Aug 1998 23:07:48 -0700 (PDT)"
References: <Pine.BSI.3.95.980823230702.5785B-100000@queernet.queernet.org>

>>>>> "RBAK" == Roger B A Klorese <rogerk@QueerNet.ORG> writes:

RBAK> ...which is why part of developing code is writing the man pages, at
RBAK> least in every software development shop I've ever worked.

Umm, yeah.  And what he's doing is taking the documentation I've written
(of which there are rather copious amounts embedded in POD form within the
code, along with the user references I've written) and making it readable
by the people who use the commands.  I'm not good at documentation.  I
realize that.  Even the reference stuff needs to be rewritten before it is
really useful to end users; I'm just too close to the code and understand
too many of the issues.  (Plus I understand things like regexps that even
your average site owner isn't going to have quite as firm a grasp on.)

Surely you can't be seriously advocating that nobody should ever adjust the
documentation that the programmers write?  Programmers tend to be some of
the worst documenters, beaten only by those VCR manual translators.

 - J<


Follow-Ups:
References:
Indexed By Date Previous: Re: randomness (was Re: Quickies)
From: Rich Pieri <rich.pieri@prescienttech.com>
Next: Re: randomness (was Re: Quickies)
From: Oliver Xymoron <oxymoron@waste.org>
Indexed By Thread Previous: Re: admin_commands, take two
From: "Roger B.A. Klorese" <rogerk@QueerNet.ORG>
Next: Re: admin_commands, take two
From: "Roger B.A. Klorese" <rogerk@QueerNet.ORG>

Google
 
Search Internet Search www.greatcircle.com