[perl5.git] / Porting / docs-team-charter.pod

=head1 NAME

docs-team-charter - Perl Documentation Team Charter

=head1 SUMMARY

This is the founding charter for the Perl Documentation Team.

The Perl project has a documentation sub-project, responsible for
maintaining the quality and consistency of Perl's core documentation.

This project is managed by the Documentation Team (a.k.a. "Docs Team").

=head2 Mission and Duties

=head3 Mission statement

The Perl Documentation Team oversees the quality, accessibility, and
maintainability of Perl's core documentation.

=head3 The mission in-depth

A few definitions of terms appearing in the mission statement:

=over

=item Perl's core documentation

By "core documentation", we mean all the documentation that ships with
Perl itself: stand-alone documents, function reference sections, and
documentation attached to standard modules.

Even though much of that standard module documentation doesn't exist
within Perl's core source distribution, the Docs Team still monitors
their state on CPAN, and actively makes recommendations to improve them
as needed.

=item Quality

The obvious job. The Docs Team is responsible for the core docs staying
up-to-date, consistently readable, and correct.

=item Accessibility

The Docs Team makes sure that Perl's core docs are discoverable and
navigable by all the language's users, new and old, across all relevant
media. This includes the web.

=item Maintainability

The Docs team treats the core docs as a proper FOSS concern, within the
larger Perl project.

This includes enthusiastically welcoming patches from the community, and
making it easy for any interested reader to discover how they can
contribute to the documentation project. It also includes working with
Core Team to make sure that docs stay synchronized with new Perl
releases.

=back

=head3 Duties

=over

=item *

Actively reviewing and improving Perl's existing collection of core
documentation. This includes revising this documentation as needed for
the sake of style, consistency, and modern best practices.

=item *

Assisting Perl contributors in making sure that any core documentation
they add or update adheres to established standards.

=item *

Encouraging the community to contribute to Perl's documentation, making
the process of submitting contributions clear and rewarding.

=item *

Fostering projects to improve the accessibility of Perl's core
documentation, across various media.

=back

=head2 Personnel

The Docs Team consists of one manager and any number of other volunteers.

The Docs Team manager is appointed by the Perl Steering Council, and may be
removed or replaced by them as well.

Both the manager and the Steering Council may add volunteers to or remove
volunteers from the Docs Team.

=head2 Resources

=head3 Mailing list

The Docs Team will maintain a publicly-archived mailing list for discussion of
its work.  The mailing list will be the medium of record for recording team
plans and decisions.  It must be possible for the Steering Council to transfer
the rights to the list when a change in Docs Team management occurs.

The current mailing list can be found at I<< to be determined >>.

=head3 Real-time chat

The team also collaborates on the C<< #docs >> channel on irc.perl.org.  The
manager may migrate this to other chat systems in the future at their own
discretion.

=head3 Funding

When appropriate, the team will seek funding for specific projects or materials
via grants from The Perl Foundation or similar sources, just as with any other
Perl infrastructure project. All Docs Team members otherwise serve on a
volunteer basis.
Commit	Line	Data
c3e80dec RS	1	=head1 NAME
	2
	3	docs-team-charter - Perl Documentation Team Charter
	4
	5	=head1 SUMMARY
	6
	7	This is the founding charter for the Perl Documentation Team.
	8
	9	The Perl project has a documentation sub-project, responsible for
	10	maintaining the quality and consistency of Perl's core documentation.
	11
	12	This project is managed by the Documentation Team (a.k.a. "Docs Team").
	13
	14	=head2 Mission and Duties
	15
	16	=head3 Mission statement
	17
	18	The Perl Documentation Team oversees the quality, accessibility, and
	19	maintainability of Perl's core documentation.
	20
	21	=head3 The mission in-depth
	22
	23	A few definitions of terms appearing in the mission statement:
	24
	25	=over
	26
	27	=item Perl's core documentation
	28
	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.
	32
	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
	36	as needed.
	37
	38	=item Quality
	39
	40	The obvious job. The Docs Team is responsible for the core docs staying
	41	up-to-date, consistently readable, and correct.
	42
	43	=item Accessibility
	44
	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.
	48
	49	=item Maintainability
	50
	51	The Docs team treats the core docs as a proper FOSS concern, within the
	52	larger Perl project.
	53
	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
	58	releases.
	59
	60	=back
	61
	62	=head3 Duties
	63
	64	=over
65
66	=item *
67
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.
71
72	=item *
73
74	Assisting Perl contributors in making sure that any core documentation
75	they add or update adheres to established standards.
76
77	=item *
78
79	Encouraging the community to contribute to Perl's documentation, making
80	the process of submitting contributions clear and rewarding.
81
82	=item *
83
84	Fostering projects to improve the accessibility of Perl's core
85	documentation, across various media.
86
87	=back
88
89	=head2 Personnel
90
91	The Docs Team consists of one manager and any number of other volunteers.
92
93	The Docs Team manager is appointed by the Perl Steering Council, and may be
94	removed or replaced by them as well.
95
96	Both the manager and the Steering Council may add volunteers to or remove
97	volunteers from the Docs Team.
98
99	=head2 Resources
100
101	=head3 Mailing list
102
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.
107
108	The current mailing list can be found at I<< to be determined >>.
109
110	=head3 Real-time chat
111
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
114	discretion.
115
116	=head3 Funding
117
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
121	volunteer basis.