[openbeos] Re: Haiku Documentation
- From: Zenja Solaja <solaja@xxxxxxxxx>
- To: openbeos@xxxxxxxxxxxxx
- Date: Thu, 28 Jul 2005 20:12:04 +1000
One thing which I think every good documentation needs is
**examples**. For most experienced developers, they use the BeBook
more as a reference guide, where you only need a reminder of which
argument does what. But for beginners, well, the water really is
deep. Otherwise, your start looks very promising.
Having examples (one example per class) should be sufficient. An
opportunity for the lazy perhaps? (look, a pink elephant, he shouts
while diving behind cover ).
Also, has anyone thought of making the HaikuBook a WikiPage, where
anyone can contribute / edit data? That will definately solve the
*old* documentation problem which plagues many projects. Plus you can
have links to actual code examples. (eg. like
http://gpwiki.org/index.php/Main_Page - the game programming wiki).
All you need to do is export the latest wikipage to disk when
releasing every Haiku update.
Other related posts:
