Single source man pages? (Was: do you write or edit man pages?)

Subject: Single source man pages? (Was: do you write or edit man pages?)
From: Peter Kleczka <pkleczka -at- yahoo -dot- com>
To: TECHWR-L <TECHWR-L -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 Feb 2000 21:29:05 -0800 (PST)

>
> --- Christi <christi -at- sageinst -dot- COM> wrote:
> Hi,
>
> I'm wondering if anyone writes or edits man pages
> as
> part of your job?
[Snip] While they are generally ok; they are
> written in passive voice.

Christi

Your post reminded me that I think I saw
something about a program that extracted
the text comments from code in order to
create man pages. Perhaps if you wanted
to re-write man pages you might also
have to re-write the comments in someones
code. Perhaps that would'nt sit well
with the programmers, or perhaps it
might look strange if the programming
comments were written in active-first
person voice.

At any rate I was impressed when I
learned that programmers might
actually structure their comments
so those same comments could also
be used to generate man pages.
Sounds like a great way to single
source!

If any of you TechWrl's can point
me to information about how
programmers actually go about
structuring their comments so that
the comments can be extracted to
produce the documentation, please
let me know.

Thanks
Pete Kleczka
(pkleczka -at- yahoo -dot- com)

__________________________________________________
Do You Yahoo!?
Talk to your friends online with Yahoo! Messenger.
http://im.yahoo.com




Previous by Author: Word - points to lines per inch?
Next by Author: RE: Help needed with [financial] terminology
Previous by Thread: Pyramid Principle by Barbara Minto
Next by Thread: Re: Single source man pages? (Was: do you write or edit man pages?)


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

Sponsored Ads


Sponsored Ads