John C put some requirements into the docck plugin, so determining what they are and writing them out would be a good start. My thoughts:

* must have appropriate license files (LICENSE.txt, NOTICE.txt, POM element)
* must have a comprehensive reference of each option available in a plugin
* must have link to the API docs of of additional types (eg MavenArchiveConfiguration) * must describe how the configuration of some elements affects others, where applicable (for example, surefire's suiteXmlFiles disables the includes/excludes options) * must have howto documents for the most common use cases (this should not just be boilerplate plugin inclusion and configuration, but an explanation of configuration)
* must document relationship with other plugins
* should document the version of a plugin a feature was added in for new features (this will not affect the first revision of the distribution - in the next one it should be referenced as must)



Mike Perham wrote:
John, as you note there's no definitive answer.  I've stressed the need
for usecase-based documentation which walks the user through the steps
required to do X, Y and Z.  The clover plugin does a good job of this in
its howto.apt.
-----Original Message-----
From: John Tolentino [mailto:[EMAIL PROTECTED] Sent: Friday, May 19, 2006 4:23 AM
To: dev@maven.apache.org
Subject: Standards for documenting plugins

Hi,

We're creating APT docs for the plugins. Currently there are no
standards on the format and content of a maven plugin site
documentation. Anybody have suggestions?

Regards,
John

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


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



--
Apache Maven - http://maven.apache.org/
Better Builds with Maven - http://library.mergere.com/

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

Reply via email to