On Mon, 2006-03-06 at 18:39 -0600, Wayne Fay wrote:
> I agree completely with many of your points.
> 
> But this is the [EMAIL PROTECTED] list, and unfortunately, a very small
> percentage of the people on this list have an ability to actually do
> much about the situation with the documentation. Other than of course
> write something and put it up in our blog, post it on the email list
> as a HOWTO, perhaps submit it as an Enhancement in JIRA and hope the
> Maven dev group accepts it and posts it in the documentation etc.

[snip]
> I'm all ears if anyone on this list has recommendations for how to
> "solve" this problem, at least for the Maven project...

Documentation is always last for developers :-). As it happens, however,
it is the area that *users* can productively contribute back to a
project.

For a project like this (a small developer core but a very large user
base) a Wiki documentation site would seem tome to be an ideal fit. The
"User FAQ" facility where skilled users can post FAQ entries for newbies
is a step in that direction, but it is somewhat limited. And as a newbie
to maven2 myself, that FAQ is already intimidatingly large and
unstructured.

As it happens, there is a Maven wiki here:
  http://docs.codehaus.org/display/MAVENUSER/Home

(The standard Apache wiki site http://wiki.apache.org/maven/
refers people to it).

There's a reasonable amount of content already, actually.

I would simply suggest putting a very prominent link to that wiki site
from the Maven homepage or documentation page - and maybe migrating all
the FAQ content onto the wiki.

The matter of adequate maven documentation then becomes the
responsibility of us, the users! From time to time wiki content may be
migrated into the core docs hosted on the maven site but there would be
no great urgency on that.

Cheers,

Simon




---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to