Re: Standards for documenting plugins

2006-05-19 Thread Brett Porter
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

RE: Standards for documenting plugins

2006-05-19 Thread Mike Perham
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 PRO