You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by Rodent of Unusual Size <Ke...@Golux.Com> on 2004/09/15 13:47:44 UTC

'live' documentation

-----BEGIN PGP SIGNED MESSAGE-----

i've heard a few comments/suggestions about maybe having the
docco be user-annotatable, so i thought i'd bring it up.

to see what i mean, take a look at the php documentation, say
at http://us4.php.net/manual/en/function.strstr.php -- search down
for 'user contributed notes'.

the php project has a lot of success with this.  the comments
are backed by a database (!), and static versions are generated
for mirroring.  so the amount of dynamicness is limited and
performance maintained.

does this sound like something it would be worthwhile to investigate?
- --
#ken	P-)}

Ken Coar, Sanagendamgagwedweinini  http://Ken.Coar.Org/
Author, developer, opinionist      http://Apache-Server.Com/

"Millennium hand and shrimp!"

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iQCVAwUBQUgr35rNPMCpn3XdAQGYoQP7Bk32kSpaLVZbgFpLN/z+SJO/b/G+Nwb5
YnvIcU/hOAZrXo5iK1ENNdIXCgtwRu/YcwnmhuYMLar/vFxHbo2B8ph6gk1eUsWE
Bgong2T+lE1sY+x2NEIWLKaRS3fflvIYoUsZI5u96qFAu3v14tSOpaHJqItyDcXX
SzQc1Md38C8=
=H4rp
-----END PGP SIGNATURE-----

Re: 'live' documentation

Posted by Jonas S Karlsson <js...@yesco.org>.
Rodent of Unusual Size wrote:
> i've heard a few comments/suggestions about maybe having the
> docco be user-annotatable, so i thought i'd bring it up.
>
> to see what i mean, take a look at the php documentation, say
> at http://us4.php.net/manual/en/function.strstr.php -- search down
> for 'user contributed notes'.
[snipp]
> does this sound like something it would be worthwhile to investigate?

+1

I'm all for it, as a user I often find the comments/examples, issues
and solutions more valuable than the actual documentation. Better than
searching bad FAQs and news/mailinglists.

/Jonas

PS: Oh no! He cross-posted! Blam! ;) Isn't "everyone" on the user list too?