diff --git a/files/en-us/mdn/contribute/documentation_priorities/index.html b/files/en-us/mdn/contribute/documentation_priorities/index.html new file mode 100644 index 000000000000000..eca77a79ed7f611 --- /dev/null +++ b/files/en-us/mdn/contribute/documentation_priorities/index.html @@ -0,0 +1,224 @@ +--- +title: MDN documentation priority list +slug: MDN/Contribute/Documentation_priorities +tags: + - Best practices + - Community + - MDN + - Documentation + - Priorities +--- +

{{MDNSidebar}}

+ +

This document defines the different priority tiers on MDN, and states what documentation topics exist inside each tier — we are calling them Tier 1 and Tier 2.

+ +

The purpose of this document is two-fold:

+ + + +

The relative importance of these docs has been decided purely by looking at page view figures. There are lots of measures we could have used, but page views is objective and still a good indicator — more important web technologies are looked up more often, and therefore fixing problems with those docs seems most critical.

+ +

Also bear in mind that these Tiers are made up of isolated document trees (i.e. the linked page, plus all of the documents in the hierarchy below it). Sometimes a Tier 1 document will link to a Tier 2 document, or vice versa, and that is OK.

+ +

The numbers in parentheses after each document tree represent the number of documents under that tree. These numbers will likely change over time, so may need revisiting before too long.

+ +

Tier 1

+ +

Tier 1 content is the most important content on MDN — it has the most users, and is deemed to cover the most important technologies for the web platform.

+ + + +

Total Tier 1 pages: 4150

+ +

Tier 2

+ +

Tier 2 content is less commonly-used, but useful nonetheless.

+ + + +

Total Tier 2 pages: 6502

+ +

Other content

+ +

There is other content on MDN that is outside our web platform technology remit — such as archived content and Firefox-specific docs (e.g. DevTools, platform internals). This content has been deprioritised completely, and in most cases we are trying to find new homes for it, or delete it if it is no longer useful. We would not recommend that our community spends any time working on any areas not specifically listed on this page.

+ +

Tier 1 WebAPIs

+ +

The following API interface reference documents (and their child pages) are currently considered Tier 1. For more information on the rationale for these groupings and priorities, see the work done in https://github.com/mdn/sprints/issues/3327.

+ +

Canvas API (112)

+ + + +

Clipboard API (13)

+ + + +

DOM (439)

+ +
+

Note

+

"DOM" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other DOM interfaces not in this list are in Tier 2.

+
+ + + +

DOM Events (22)

+ +
+

Note

+

"DOM Events" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other DOM Events interfaces not in this list are in Tier 2.

+
+ + + +

Fetch API (47)

+ + + +

File API (48)

+ + + +

HTML DOM (371)

+ +
+

Note

+

"HTML DOM" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other HTML DOM interfaces not in this list are in Tier 2.

+
+ + + +

URL API (43)

+ + + +

Web Storage API (8)

+ + + +

WebSockets API (28)

+ + + +

XMLHttpRequest (58)

+ + diff --git a/files/en-us/mdn/contribute/index.html b/files/en-us/mdn/contribute/index.html index 30902b91fcb2360..dd2320370e504f5 100644 --- a/files/en-us/mdn/contribute/index.html +++ b/files/en-us/mdn/contribute/index.html @@ -70,6 +70,13 @@

Primary contribution types

We will add more tasks here as time goes on.

+

Priority ratings

+ +

You can also look at priority ratings to give you an idea of what the most important work is to work on — we've started giving content bug issues labels of P0, P1, P2, P3, and P4 to signify how important they are, with lower numbers being more important than higher numbers.

+ +

These are figured out during the regular MDN bug triage process, based on the MDN documentation priority list.

+ +

Other task types

If our main priorities listed above don't interest you, you can find a number of other, more general task types to get involved with below, split up by skillset.