Proposed activites of the Perl 5 Documentation Team ---------------------------------------------------
* read documentation to ensure it is friendly to new users Members will choose one or more documents or one or more sections of larger documents and read them for accuracy and clarity. Overlap is encouraged. Any issues should be posted to the [Perl Documentation list][1]. * fix documentation that is not friendly to new users The Pumppawn will mark sections of the documentation as needing rewriting in the issues section of the [master GitHub repo[2]. Members will choose (or optionally be assigned) a section from this list to rework. They will post reworked sections to GitHub or the list and the Pumppawn will merge the changes back into the master GitHub repo and push the changes out to p5p. * watch p5p for incoming documentation patches and forward acceptable patches on to committers Any documentation patches posted to [p5p][3] should be discussed on p5p, and if they are good passed on to a person with a commit bit and committed to the master GitHub documentation repo. This is to reduce the workload on the release manager. * ensure all documentation patches contain a patch against the current delta Any patch submitted to p5p by members should include a change to the current perldelta in the documented style. Any documentation patch submitted to p5p by non-members should be checked for a change to the current perldelta and the change should be added if it isn't there or in an incorrect format. This is to reduce the workload on the release manager. * watch p5p for incoming patches that might affect documentation All patches submitted to p5p should be scanned for changes that might affect documentation. If any changes are needed, then members will submit the changes to the Perl Documentation mailing list or p5p. * update the examples in the documentation to a modern style * ensure that all examples longer than one line contain a use statement that indicates the minimum version of Perl 5 that can run the example. * ensure that all jargon is defined in perlglossary These are ongoing projects with no fixed end date and all new documentation should be scanned for these issues. [1]: http://lists.perl.org/list/perl-documentation.html [2]: http://github.com/Perl-5-Documentation-Team/perl [3]: http://lists.perl.org/list/perl5-porters.html -- Chas. Owens wonkden.net The most important skill a programmer can have is the ability to read.
