From: David Douthitt <DDouthitt@...>
Date: 2002-09-05T06:11:20+09:00
Subject: Re: suggestions to the Ruby community

This is a MIME message. If you are reading this text, you may want to 
consider changing to a mail reader or gateway that understands how to 
properly handle MIME multipart messages.

----=_NextPart_ST_16_11_15_Wednesday_September_04_2002_2105
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: quoted-printable

John said:

One new possibility is wiki.

I suggest people decide on a man style format.
Even if it is not compleltely standard from the start
it will evolve. Finally, all documentation be put on
a wiki with version control. Anybody can modify
or annotate the docs and  after some time
a people wishing to earn a reputation as
a writer can review the history of documentation
changes and evolve the documentaton
to the next level.

[snip]

I would encourage not using a Wiki - for these reasons:

* Requires yet another password, login, signup, address, name, ...
* Can't be downloaded and set up like HTML pages (like the ruby-man and rub=
y-ref, which are wonderful!)
* Can't be printed out for hard copy
* Can't be used offline

However, rdoc and rtool can both be used offline and can create documentati=
on suitable for offline use; same goes for man pages.

For general documentation, why not use DocTool?


David Douthitt
CUNA & Affiliates
UNIX Systems Administrator
ddouthitt@cuna.coop

----=_NextPart_ST_16_11_15_Wednesday_September_04_2002_2105
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; charset=3Diso-8859-1"=
>
<META content=3D"MSHTML 5.50.4912.300" name=3DGENERATOR></HEAD>
<BODY style=3D"MARGIN-TOP: 2px; FONT: 8pt Microsoft Sans Serif; MARGIN-LEFT=
: 2px">
<DIV>John said:<BR><BR>One new possibility is wiki.<BR><BR>I suggest people=
=20
decide on a man style format.</DIV>
<DIV>Even if it is not compleltely standard from the start</DIV>
<DIV>it will evolve. Finally, all documentation be put on</DIV>
<DIV>a wiki with version control. Anybody can modify<BR>or annotate the doc=
s=20
and&nbsp; after some time</DIV>
<DIV>a people wishing to earn a reputation as</DIV>
<DIV>a writer can review the history of documentation</DIV>
<DIV>changes and evolve the documentaton</DIV>
<DIV>to the next level.</DIV>
<DIV>&nbsp;</DIV>
<DIV>[snip]</DIV>
<DIV>&nbsp;</DIV>
<DIV>I would encourage not using a Wiki - for these reasons:</DIV>
<DIV>&nbsp;</DIV>
<DIV>* Requires yet another password, login, signup, address, name, ...</DI=
V>
<DIV>* Can't be downloaded and set up like HTML pages (like the ruby-man an=
d=20
ruby-ref, which are wonderful!)</DIV>
<DIV>* Can't be printed out for hard copy</DIV>
<DIV>* Can't be used offline</DIV>
<DIV>&nbsp;</DIV>
<DIV>However, rdoc and rtool can both be used offline and can create=20
documentation suitable for offline use; same goes for man pages.</DIV>
<DIV>&nbsp;</DIV>
<DIV>For general documentation, why not use DocTool?</DIV>
<DIV>&nbsp;</DIV>
<DIV>&nbsp;</DIV>
<DIV>David Douthitt<BR>CUNA &amp; Affiliates<BR>UNIX Systems Administrator<=
BR><A=20
href=3D"mailto:ddouthitt@cuna.coop">ddouthitt@cuna.coop</A></DIV>
<DIV>&nbsp;</DIV>
<DIV>&nbsp;</DIV></BODY></HTML>

----=_NextPart_ST_16_11_15_Wednesday_September_04_2002_2105--