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