1*256a93a4Safresh1=head1 NAME 2*256a93a4Safresh1 3*256a93a4Safresh1docs-team-charter - Perl Documentation Team Charter 4*256a93a4Safresh1 5*256a93a4Safresh1=head1 SUMMARY 6*256a93a4Safresh1 7*256a93a4Safresh1This is the founding charter for the Perl Documentation Team. 8*256a93a4Safresh1 9*256a93a4Safresh1The Perl project has a documentation sub-project, responsible for 10*256a93a4Safresh1maintaining the quality and consistency of Perl's core documentation. 11*256a93a4Safresh1 12*256a93a4Safresh1This project is managed by the Documentation Team (a.k.a. "Docs Team"). 13*256a93a4Safresh1 14*256a93a4Safresh1=head2 Mission and Duties 15*256a93a4Safresh1 16*256a93a4Safresh1=head3 Mission statement 17*256a93a4Safresh1 18*256a93a4Safresh1The Perl Documentation Team oversees the quality, accessibility, and 19*256a93a4Safresh1maintainability of Perl's core documentation. 20*256a93a4Safresh1 21*256a93a4Safresh1=head3 The mission in-depth 22*256a93a4Safresh1 23*256a93a4Safresh1A few definitions of terms appearing in the mission statement: 24*256a93a4Safresh1 25*256a93a4Safresh1=over 26*256a93a4Safresh1 27*256a93a4Safresh1=item Perl's core documentation 28*256a93a4Safresh1 29*256a93a4Safresh1By "core documentation", we mean all the documentation that ships with 30*256a93a4Safresh1Perl itself: stand-alone documents, function reference sections, and 31*256a93a4Safresh1documentation attached to standard modules. 32*256a93a4Safresh1 33*256a93a4Safresh1Even though much of that standard module documentation doesn't exist 34*256a93a4Safresh1within Perl's core source distribution, the Docs Team still monitors 35*256a93a4Safresh1their state on CPAN, and actively makes recommendations to improve them 36*256a93a4Safresh1as needed. 37*256a93a4Safresh1 38*256a93a4Safresh1=item Quality 39*256a93a4Safresh1 40*256a93a4Safresh1The obvious job. The Docs Team is responsible for the core docs staying 41*256a93a4Safresh1up-to-date, consistently readable, and correct. 42*256a93a4Safresh1 43*256a93a4Safresh1=item Accessibility 44*256a93a4Safresh1 45*256a93a4Safresh1The Docs Team makes sure that Perl's core docs are discoverable and 46*256a93a4Safresh1navigable by all the language's users, new and old, across all relevant 47*256a93a4Safresh1media. This includes the web. 48*256a93a4Safresh1 49*256a93a4Safresh1=item Maintainability 50*256a93a4Safresh1 51*256a93a4Safresh1The Docs team treats the core docs as a proper FOSS concern, within the 52*256a93a4Safresh1larger Perl project. 53*256a93a4Safresh1 54*256a93a4Safresh1This includes enthusiastically welcoming patches from the community, and 55*256a93a4Safresh1making it easy for any interested reader to discover how they can 56*256a93a4Safresh1contribute to the documentation project. It also includes working with 57*256a93a4Safresh1Core Team to make sure that docs stay synchronized with new Perl 58*256a93a4Safresh1releases. 59*256a93a4Safresh1 60*256a93a4Safresh1=back 61*256a93a4Safresh1 62*256a93a4Safresh1=head3 Duties 63*256a93a4Safresh1 64*256a93a4Safresh1=over 65*256a93a4Safresh1 66*256a93a4Safresh1=item * 67*256a93a4Safresh1 68*256a93a4Safresh1Actively reviewing and improving Perl's existing collection of core 69*256a93a4Safresh1documentation. This includes revising this documentation as needed for 70*256a93a4Safresh1the sake of style, consistency, and modern best practices. 71*256a93a4Safresh1 72*256a93a4Safresh1=item * 73*256a93a4Safresh1 74*256a93a4Safresh1Assisting Perl contributors in making sure that any core documentation 75*256a93a4Safresh1they add or update adheres to established standards. 76*256a93a4Safresh1 77*256a93a4Safresh1=item * 78*256a93a4Safresh1 79*256a93a4Safresh1Encouraging the community to contribute to Perl's documentation, making 80*256a93a4Safresh1the process of submitting contributions clear and rewarding. 81*256a93a4Safresh1 82*256a93a4Safresh1=item * 83*256a93a4Safresh1 84*256a93a4Safresh1Fostering projects to improve the accessibility of Perl's core 85*256a93a4Safresh1documentation, across various media. 86*256a93a4Safresh1 87*256a93a4Safresh1=back 88*256a93a4Safresh1 89*256a93a4Safresh1=head2 Personnel 90*256a93a4Safresh1 91*256a93a4Safresh1The Docs Team consists of one manager and any number of other volunteers. 92*256a93a4Safresh1 93*256a93a4Safresh1The Docs Team manager is appointed by the Perl Steering Council, and may be 94*256a93a4Safresh1removed or replaced by them as well. 95*256a93a4Safresh1 96*256a93a4Safresh1Both the manager and the Steering Council may add volunteers to or remove 97*256a93a4Safresh1volunteers from the Docs Team. 98*256a93a4Safresh1 99*256a93a4Safresh1=head2 Resources 100*256a93a4Safresh1 101*256a93a4Safresh1=head3 Mailing list 102*256a93a4Safresh1 103*256a93a4Safresh1The Docs Team will maintain a publicly-archived mailing list for discussion of 104*256a93a4Safresh1its work. The mailing list will be the medium of record for recording team 105*256a93a4Safresh1plans and decisions. It must be possible for the Steering Council to transfer 106*256a93a4Safresh1the rights to the list when a change in Docs Team management occurs. 107*256a93a4Safresh1 108*256a93a4Safresh1The current mailing list can be found at I<< to be determined >>. 109*256a93a4Safresh1 110*256a93a4Safresh1=head3 Real-time chat 111*256a93a4Safresh1 112*256a93a4Safresh1The team also collaborates on the C<< #docs >> channel on irc.perl.org. The 113*256a93a4Safresh1manager may migrate this to other chat systems in the future at their own 114*256a93a4Safresh1discretion. 115*256a93a4Safresh1 116*256a93a4Safresh1=head3 Funding 117*256a93a4Safresh1 118*256a93a4Safresh1When appropriate, the team will seek funding for specific projects or materials 119*256a93a4Safresh1via grants from The Perl Foundation or similar sources, just as with any other 120*256a93a4Safresh1Perl infrastructure project. All Docs Team members otherwise serve on a 121*256a93a4Safresh1volunteer basis. 122