3 docs-team-charter - Perl Documentation Team Charter
7 This is the founding charter for the Perl Documentation Team.
9 The Perl project has a documentation sub-project, responsible for
10 maintaining the quality and consistency of Perl's core documentation.
12 This project is managed by the Documentation Team (a.k.a. "Docs Team").
14 =head2 Mission and Duties
16 =head3 Mission statement
18 The Perl Documentation Team oversees the quality, accessibility, and
19 maintainability of Perl's core documentation.
21 =head3 The mission in-depth
23 A few definitions of terms appearing in the mission statement:
27 =item Perl's core documentation
29 By "core documentation", we mean all the documentation that ships with
30 Perl itself: stand-alone documents, function reference sections, and
31 documentation attached to standard modules.
33 Even though much of that standard module documentation doesn't exist
34 within Perl's core source distribution, the Docs Team still monitors
35 their state on CPAN, and actively makes recommendations to improve them
40 The obvious job. The Docs Team is responsible for the core docs staying
41 up-to-date, consistently readable, and correct.
45 The Docs Team makes sure that Perl's core docs are discoverable and
46 navigable by all the language's users, new and old, across all relevant
47 media. This includes the web.
51 The Docs team treats the core docs as a proper FOSS concern, within the
54 This includes enthusiastically welcoming patches from the community, and
55 making it easy for any interested reader to discover how they can
56 contribute to the documentation project. It also includes working with
57 Core Team to make sure that docs stay synchronized with new Perl
68 Actively reviewing and improving Perl's existing collection of core
69 documentation. This includes revising this documentation as needed for
70 the sake of style, consistency, and modern best practices.
74 Assisting Perl contributors in making sure that any core documentation
75 they add or update adheres to established standards.
79 Encouraging the community to contribute to Perl's documentation, making
80 the process of submitting contributions clear and rewarding.
84 Fostering projects to improve the accessibility of Perl's core
85 documentation, across various media.
91 The Docs Team consists of one manager and any number of other volunteers.
93 The Docs Team manager is appointed by the Perl Steering Council, and may be
94 removed or replaced by them as well.
96 Both the manager and the Steering Council may add volunteers to or remove
97 volunteers from the Docs Team.
103 The Docs Team will maintain a publicly-archived mailing list for discussion of
104 its work. The mailing list will be the medium of record for recording team
105 plans and decisions. It must be possible for the Steering Council to transfer
106 the rights to the list when a change in Docs Team management occurs.
108 The current mailing list can be found at I<< to be determined >>.
110 =head3 Real-time chat
112 The team also collaborates on the C<< #docs >> channel on irc.perl.org. The
113 manager may migrate this to other chat systems in the future at their own
118 When appropriate, the team will seek funding for specific projects or materials
119 via grants from The Perl Foundation or similar sources, just as with any other
120 Perl infrastructure project. All Docs Team members otherwise serve on a