Just my two cents.
I did not fully ready every post on this topic but the most of them. If
anyone mentioned it before please forgive me :)

Please do think of the target audience before planning this type of
documentation section. And do think of the way they are usually learning
things. "The maven way" won't be a site full of plain explanations and
documentations. It is focused on newbies and focused on teach them the
right way. Some things are not mentioned and some things are not explained
but linked to more detailed documents.

Let me tell some nice story. A friend of mine reviewed a project homepage.
What was the first thing he said? "Ugh - no screenshots". I told him that
there are not that many screenshots because I did not plan to simply
screenshot a windows CLI where maven prints "SUCCESS". I would not expect
it myself on a maven homepage. But after a while I began to think about it.
Why aren't there any screenshots in my documentation?

I do not think thousands of documentation variants are clever but pick up
two or three of them. A small example:
- "Video tutorial explaining the maven way"
- "Practical tutorial for maven java projects and the maven way"
- "Textual explanation of the maven way".
The first newbie likes videos, shares them at youtube and twitter. The
second newbie likes books (from sonatype). The third developer likes to
view at screenshots or "5-minute-cookbooks" without too many explanations
and tries to directly follow the tutorial instructions and play with maven
"live". etc.


Someone already said it (did not find the post, maybe I deleted it...) that
the maven homepages are mainly focused on plugin developers. The typical
newbie maybe a xxx developer (java or any other programming language we
have a plugin for). But the newbie is not the typical plugin developer. The
typical newbie does not need the detailed explanation of how to control the
Jvm parameters of JUnit invocations. He will indeed need it after some
weeks or as soon as running into trouble because of OutOfMemory.

Reply via email to