Hi,
My response inline...
Tim O'Brien wrote:
Developers don't write great documentation. Don't raise the bar so high
that people are discouraged from submitting doco-less patches. Just create
a structure to address documentation deficiency.
Sorry, but IMHO that's too much of a generalization on developer's
'documentation' skills and I don't agree... and definately not for for a
project like Maven. Ideas jotted in Brett's email are worth implementing
and I commend him and the team on putting them forth for a discussion
here. I am sure Maven community will notice if the bar is set too high!
1. Create a documentation posse - identify people who will focus solely on
doco, reduce the barriers for them to commit. Or, move documentation to an
external project with lower barriers to entry.
-1 for external project, documentation is intrinsic to the project, not
sure what's the benefit of having another external project.
2. Consider a separate list - people removed from the development process
produce better documentation.
-1, user and dev lists are suited enough for doc related
questions/discussions. Enough mails are floating on these lists to
gather ideas and content for documentation. I am not aware of an
instance where this generalization above about producing better
documentation by people not in development applies.
3. Add "Waiting for Documentation" as a stage in a customized JIRA
workflow. Instead of creating separate issues for "Document what I just did
in the Site Plugin", give developers the opportunity to just mark something
as implemented but undocumented (otherwise know n as useless and invisible)
[snip]
Cheers,
Rahul
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
