Guidelines - The MDN project 编辑

These guides provide details on how MDN documentation should be written and formatted, as well as how our code samples and other content should be presented. By following these guides, you can ensure that the material you produce is clean and easy to use.

Code example guidelines

This document series outlines the coding guidelines and best practices we use for writing demos, code snippets, interactive examples, etc, for use on MDN.

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.

Editorial policies

This article describes the policies set by the Mozilla MDN staff to govern the content on MDN web docs.

Guide to classes and styles used in MDN content

MDN has many built-in global styles available for use when styling and laying out articles, and this article is a guide to the available classes and when to use them.

MDN conventions and definitions

This article defines some conventions and definitions that are commonly used on MDN, which might not be obvious to some people when they come across them in the documentation.

Video content on MDN

MDN Web Docs is not a very video-heavy site, but there are certain places where video content makes sense to use as part of an article. This article discusses when including videos in MDN articles is appropriate, and provides tips on how to create simple but effective videos on a budget.

Writing style guide

To present documentation in an organized, standardized, and easy-to-read manner, the MDN Web Docs style guide describes how text should be organized, spelled, formatted, and so on. These are guidelines rather than strict rules.