Please don’t use Wiki for docs… at least not exclusively.
To me Wiki’s are overrated:
They can be ignored - questions come up, then don’t get answered
Most require registration - my name, address, phone number, email address are in enough places already - and I don’t need to memorize another password
Some get a number of “New Item” listings because people don’t know how to use them, and admins don’t delete them
They require Internet access; suppose I’m not connected?
To docs should be in man pages - not in info format (like GNU), not perldoc format, not in a “convertable” format - not even in bundled html pages. Every system you find will have man; most don’t have lynx or info or rdtool, etc.
David Douthitt
CUNA & Affiliates
UNIX Systems Administrator
ddouthitt@cuna.coop
yuchingtien@yahoo.com 8/31/02 8:37PM >>>
instead of everyone writing your own documentation, wouldnt a wiki
documentation better? everyone could just ‘fix’ what is wrong, add
exemples. japanese documentation could just be put there and then
somebody else who knows japanese and english could translate it later.
You’re assuming every system in existence (or every system that runs ruby) is
UNIX or a clone of it. It would be nice if you could choose which type of
documentation formats you want to be generated at compile time with ruby,
which means one of the doc making tools would have to be included with it.
···
On September 3, 2002 10:44 am, David Douthitt wrote:
To docs should be in man pages - not in info format (like GNU), not perldoc
format, not in a “convertable” format - not even in bundled html pages.
Every system you find will have man; most don’t have lynx or info or
rdtool, etc.
To docs should be in man pages - not in info format (like GNU), not perldoc
format, not in a “convertable” format - not even in bundled html pages.
Every system you find will have man; most don’t have lynx or info or
rdtool, etc.
You’re assuming every system in existence (or every system that runs ruby) is
UNIX or a clone of it. It would be nice if you could choose which type of
documentation formats you want to be generated at compile time with ruby,
which means one of the doc making tools would have to be included with it.
+1 by me. I’d like to have a something like ri or perldoc where i can quickly
lookup a methods documentation like this
ri My::Module::Class.function
I’d like to have the documentation readily accessible as manpages for
unix and like javadoc for browsing on windows and to work into a new
api.
-billy.
···
On Wed, Sep 04, 2002 at 12:38:13AM +0900, nico wrote:
On September 3, 2002 10:44 am, David Douthitt wrote: