avalon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Niclas Hedhman <nic...@hedhman.org>
Subject Interesting Anti Pattern...
Date Mon, 15 Dec 2003 02:27:32 GMT

<quote src="http://www.keelframework.org/mission.shtml" >
Anti-Pattern: Documentation Problems


The best feature of open source is also its downfall - wildly varied forms of 
documentation, with its most important form also being its most problematical 
- mail lists. Funny thing is, most of the time it isn't just a lack of 
documentation, there is usually too much, and you can't find what you need 
without going through email archives for hours at a time. 
 
 Solution:
 Keel attempts to reduce documentation to javadocs, and online FAQ's editable 
by users, such as with Wiki. Email is the big problem, and we request users 
to not use it for documentation - if you answer a question, answer it in the 
Wiki FAQ, and use email only to furnish a link to right place in the Wiki 
FAQ. 
</quote>

Do we have this problem?

Niclas

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org


Mime
View raw message