discuss: Linux documentation
Subject:
Re: [discuss] Linux documentation
From:
John Eikenberry ####@####.####
Date:
14 Sep 2007 17:18:44 +0000
Message-Id: <20070914171747.GC27742@localdomain>
jdd wrote:
> I noticed that the php documentation is very nice and use a system
> similar to a wiki (I don't know exactly what system, but this should be
> easy to find)
>
> That is the documentation (online) is irganised as usual, but at the and
> of each page there is a user part where everybody (don't know if this is
> filtered or not, I'm not clever enough to write there) can add examples
> or remarks.
>
> This part is incredibly usefull may be we sould do a similar thing?
>
> If I remember well, when discussing the wiki, the discussion was mostly
> about editing the original document. Here the goal is to add user
> experience to it
An alternative to a wiki might be the stet system the fsf developed to
allow for commenting on the GPL3 drafts. It is an javascript app which
allows for in-line comments. Rather than trying to describe it here is a
link to the archived GPL3 with comments where you can see it in action
(javascript required obviously).
http://gplv3.fsf.org/comments/gplv3-draft-4.html
It's 'home page' is here.
http://gplv3.fsf.org/wiki/index.php/Comment_system
Might be a bit of a pain to install and I'm not sure of how well it will be
maintained in the future.
--
John Eikenberry
####@####.#### - http://zhar.net]
______________________________________________________________
"It is difficult to produce a television documentary that is both incisive
and probing when every twelve minutes one is interrupted by twelve dancing
rabbits singing about toilet paper." - Rod Serling
