On Saturday 06 January 2007 06:41, Vincent Massol wrote:
Hi,
I think we need to improve the way we update the documentation. Right now I
see several issues are marked as closed even though we haven't documented
them. Typical examples include new macros. They should be documented on
xwiki.org before we close the issue IMO. At the very least if for some good
reason we cannot do it immediately at least a new issue for documenting
them should be created at the same time so that it's not forgotten and so
that it's implemented in the future.
Nobody likes documenting stuff so my belief is that someone who does
something must do it completely, i.e. design, implement, *document* and
support.
WDYT?
Excellent idea.
I'd like to see some explanations in the javadoc as well.
Is there already some guidelines about documenting code and project (I mean
tutorial, dev guide, the web site content)?