On Thu, 17 Feb 2005 13:58:40 -0800, Tim Colson (tcolson) <[EMAIL PROTECTED]> wrote: > > it might be nice to include some policy on published documentation > +1 > > > 1. published javadoc and user's guide type stuff should match latest > > released version > +1 > > > 2. published change log or other "news" type pages should be > > regularly updated to show changes since last release > +1 > > > 3. typos in published javadoc or user's guide should be fixed to > > match latest release's actual functioning, even if that puts them at > > odds with the docs bundled along with that release. > hmmm... is there a big hassle in fixing/patching the bundle too?
i think so. with branches, version tags, mirroring and md5sums and all that, it's definitely more hassle than its worth for a documentation typo. personally, for anything but a drastic typo (on par with a new-minor-version-worthy bug), i wouldn't want to bother fixing/updating anything except for the latest code in SVN and possibly the online docs. so i suppose that #3 ought to say "may be fixed" instead of "should be fixed". :) > > 4. any docs that do not reflect the latest release--whether because > > they are obsolete or cutting edge--should not be placed or left up on > > the project web site > +1 > > Cheers, > Timo > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
