I have the same remarks:
Can the user and the developer documentation be clearly separated?
For example, my game desktop application has:
- some xdocs explaining how to play a game
- FAQ for the user, generated through maven-faq-report
- some xdocs for developpers wanted to join our open source project
- all the other generated xdocs, including maybe even FAQ's

The first two should be visible on entry, all the other stuff should be
hidden under a collapsed menu link
(including project documentation).

Any project you can think of, will have a clear separation of those just
wanting to use the project and those wanted to develop it further.
But many projects will have a minimal user IQ of that of a chimp, so more
then one link to the developer part might cause them confusion.

-- 
With kind regards,
Geoffrey

"pedro Cristian" <[EMAIL PROTECTED]> schreef in bericht
news:[EMAIL PROTECTED]
> Hi there,
>
> I'm starting using Maven.
>
> The features documentation of Maven states :
>
> "Distribution publication based on the POM. Once the POM is setup
accurately
> you can easily publish distributions safely knowing that the distributions
> being made match exactly what has been tagged in your repository."
>
> The reports generated by Maven on the project are important for anybody
inside
> the project.
>
> However, they are less meaningful for people outside.
>
> How to get maven to generate user-centered documentation? Is there
something
> like a tag separating private vs. public documentation?
>
> For instance, there is the open source project OpenJMS that uses Maven.
> Does a user of this project need to download the XRef report about tests?
>
> I would like my project to build artefact with a list of specified
documents.
> However I would like the project site to have a more complete list of
document.
>
> what is the procedure in Maven? Am I missing some point?
>
> Pedro
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
> Vous manquez d'espace pour stocker vos mails ?
> Yahoo! Mail vous offre GRATUITEMENT 100 Mo !
> Cr�ez votre Yahoo! Mail sur http://fr.benefits.yahoo.com/
>
> Le nouveau Yahoo! Messenger est arriv� ! D�couvrez toutes les nouveaut�s
pour dialoguer instantan�ment avec vos amis. A t�l�charger gratuitement sur
http://fr.messenger.yahoo.com




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

Reply via email to