Does this belong on MDN Web Docs?
In this article, you'll find information describing how to decide whether or not a given topic and/or type of content should be included on MDN Web Docs. We'll also consider other places you might place content, although not in depth.
If you're preparing to document something, you may be trying to decide whether to put the information on MDN Web Docs. In addition, you may be considering maintaining documentation in your source code, putting the document on the Mozilla wiki, or in readme files in a Git repository. This article's purpose is to help you decide which of these options is right for your content.
The two main considerations for whether a document belongs on MDN are:
- The topic of the document (what is it about?)
- The nature of the document (what kind of document is it?)
In general, if it's an open web-facing technology, we document it on MDN. This means any feature that can used by Web developers creating sites and applications now and in the near future. If it is implemented by multiple browsers and either accepted as standard or is progressing towards standardization, then yes, definitely. If it is still very experimental and not implemented in multiple browsers and/or liable to change, then it is still suitable for inclusion, but may not be seen as a priority for the writer's team to work on.
The primary focus is on front-end web technologies:
Note: Back-end technologies usually have their own documentation elsewhere that MDN does not attempt to supersede, although we do have some exceptions.
Also welcome are topics that cut across technologies but are relevant to Web development, such as:
Note: MDN covers some non-standard features if they're exposed to the Web, especially if they find common usage; for example, we have documentation for WebKit-specific CSS properties. MDN also covers some non-web standards technologies if they are considered useful enough to web developers — see our Web-related technologies section.
In general, anything that isn't an open web standard does not belong on MDN. The below sections provide more specifics.
Documentation in this category includes information on both how to work with Mozilla products, as a developer, and how to contribute to these open-source projects.
While MDN Web Docs contains a large quantity of Mozilla product documentation, the focus of new content development is on open web standards. We are in the process of determining what to do about this content, so it may not make sense to create new Mozilla product documentation on MDN Web Docs. If you are working on a Mozilla product (or project that may become a product), talk to a member of the MDN staff team to discuss possible avenues for documenting your product. Also, see the section on Cases for documenting elsewhere, below.
Other examples of inappropriate topics for MDN Web Docs:
- Technology that is not exposed to the Web and is specific to a non-Mozilla browser.
- Technology that is not related to the Web or Mozilla products.
- Documentation for end-users; for Mozilla products, such documentation belongs on the Mozilla support site.
In general, MDN is for product documentation, not for project or process documentation (except about MDN itself). So, if the document is about "how to use a thing" or "how a thing works" (where the "thing" is in one of the topic categories mentioned above), then it can go on MDN. But if it about "who's working on developing a thing" or "plans for developing a thing", then it shouldn't go on MDN. In that case, if the thing is being developed under the umbrella of Mozilla, then the Mozilla project wiki may be a good place for it.
Here are some examples of types of documents that should not be placed on MDN:
- Planning documents
- Design documents
- Project proposals
- Specifications or standards
- Promotional material, advertising, or personal information