Ce sur quoi nous écrivons

Cette section décrit les règles mises en place par l'équipe MDN employée par Mozilla pour gérer le contenu de MDN. Toutes les personnes qui contribuent à MDN se doivent de respecter ces règles.

Tout le contenu présent sur MDN doit être pertinent pour la section dans laquelle il apparaît. Les publicités et autres contenus indésirables ne seront pas acceptés. Les personnes qui tentent d'ajouter ce type de contenu à plusieurs reprises pourront être bannies de MDN à la discrétion de l'équipe MDN employée par Mozilla.

Les liens sortants vers des sites commerciaux qui sont pertinents pour le sujet seront jugés au cas par cas. La valeur ajoutée pour aider les équipes de développement web doit surpasser le bénéfice commercial du site cible.

Les articles de MDN doivent respecter une neutralité de point de vue, notamment pour les différences entre les navigateurs. Tout commentaire dénigrant sur quelque navigateur ou agent utilisateur que ce soit est inacceptable.

Les technologies web documentées sur MDN doivent être spécifiées de façon ouverte et implémentées par au moins un moteur de rendu. Les variations quant à la prise en charge des différents navigateurs sont documentées dans la section de compatibilité des navigateurs d'un article.

Si vous souhaitez suggérer un nouveau contenu pour MDN, veuillez lire cette page avant votre soumission afin de vérifier qu'elle est pertinente.

Pour les nouvelles pages de référence ou les nouveaux guides, veuillez ouvrir une discussion sur le dépôt mdn-community et décrire le contenu suggéré et les raisons de cette suggestion (avec le plus de détails possible).

Pour suggérer des projets plus vastes, comme l'écriture de nouvelles sections, veuillez vous référer aux critères d'inclusion. Cette page décrit comment faire dans ce cas.

MDN documente en général les technologies web ouvertes. Cela inclut les fonctionnalités qui peuvent être utilisées par les développeuses et développeurs web pour créer des sites et applications web.

Si une fonctionnalité est implémentée par plusieurs navigateurs et acceptée comme standard ou en voie de standardisation, sa documentation a toute sa place sur MDN. Si une fonctionnalité est encore expérimentale et pas implémentée par plusieurs navigateurs ou si elle est sujette à changements, sa documentation pourra être incluse sur MDN, mais ne sera pas considérée comme prioritaire.

Autrement dit, les technologies web qui peuvent être documentées sur MDN devraient respecter les critères suivants :

• Être en voie de standardisation.
• Être spécifiée par un organisme de spécification reconnu.
• Être implémentée par au moins un moteur de rendu.
• Être diffusée par une version de navigateur stable.

Les sujets sur lesquels nous nous concentrons avant tout sont les technologies web côté client :

• HTML
• CSS
• JavaScript
• Les API web
• HTTP

Nous documentons également d'autres sujets comme SVG, XML, WebAssembly, l'accessibilité. De plus, nous écrivons des guides d'apprentissage pour ces technologies et disposons également d'un glossaire.

Le contenu présent sur MDN doit être pertinent pour la section dans laquelle il est situé. On attend des personnes qui contribuent à ce qu'elles suivent les règles d'écritures sur MDN tant pour la forme, les exemples de code que pour d'autres sujets.

Pour plus de détails quant aux critères d'acceptation pour la documentation d'une technologie sur MDN, veuillez vous référer à la page des critères d'inclusion.

Sur MDN, nous cherchons constamment à documenter les nouvelles technologies web standards dès que c'est pertinent. Nous visons un équilibre entre une publication suffisamment tôt afin que les développeuses et développeurs puissent apprendre à utiliser les fonctionnalités dès que c'est nécessaire et une publication suffisamment tardive afin que la technologie soit mature et stable afin que la documentation ne soit pas sujette à des mises à jour constantes voire à un retrait pur et simple.

En général, nous documentons une fonctionnalité au plus tôt lorsque la fonctionnalité est en voie de standardisation et implémentée quelque part.

Nous envisageons de documenter une nouvelle technologie si :

• Elle est définie dans une spécification publiée par une organisation de standardisation reconnue (W3C, WHATWG, Khronos, IETF, etc.) et a atteint un certain niveau de stabilité (par exemple un document au statut de brouillon de travail ou un candidat à recommandation du W3C ou lorsque la spécification est assez stable à en juger le nombre de bogues rédigés à son sujet).
• Elle est implémentée de façon cohérente dans au moins un navigateur et fait montre d'un certain intérêt par les équipes de développement d'autres navigateurs (comme un ticket actif ou une « intention d'implémentation » officiellement annoncée).

Nous ne documentons pas une nouvelle technologie si :

• Elle ne dispose d'aucune spécification ou si la spécification est une note brute qui semble sujette à modification.
• Un ou zéro navigateur l'a implémenté et aucun autre éditeur de navigateur ne montre d'intérêt à l'implémentation. Vous pouvez estimer ceci en demandant aux personnes qui travaillent sur ces navigateurs et en recherchant parmi les listes de diffusion ou les systèmes de ticket.
• Il ne s'agit pas d'une technologie exposée sur le Web et/ou qu'elle est complètement propriétaire.
• Il existe déjà des signes de dépréciation ou de remplacement par une fonctionnalité similaire.

En règle générale, tout ce qui n'est pas standardisé de façon ouverte pour le Web n'a pas sa place sur MDN. Les publicités commerciales et autres contenus hors-sujet ne seront jamais acceptés sur le site. Toute personne qui contribue en soumettant du spam à plusieurs reprises pourra être bannie à la discrétion de l'équipe MDN employée par Mozilla.

Voici différents exemples de sujets non-pertinents pour MDN :

• Les technologies qui ne sont pas exposées sur le Web et qui sont spécifiques à un navigateur.
• Les technologies qui ne sont pas relatives au Web.
• La documentation pour les utilisateurs finaux des sites ou des navigateurs. Ainsi, pour la documentation des produits Mozilla, celle-ci sera sur le site de support de Mozilla.
• Des liens externes d'autopromotion. Veuillez suivre le guide stylistique avant d'ajouter un lien externe.

Les pages sont supprimées de MDN si elles ne contiennent plus d'informations qui sont utiles, si elles sont trop obsolètes ou si elles contiennent trop d'informations incorrectes, au point d'êtres trompeuses.

Voici quelques scénarios qui décrivent des situations où le contenu peut être supprimé :

• Des articles contenant des informations à propos de fonctionnalités qui n'ont pas été implémentées par l'ensemble des navigateurs et qui ont ensuite été retirées (il s'agit généralement de fonctionnalités expérimentales, comme celles avec des préfixes).
• Des pages de référence qui décrivent des fonctionnalités qui ont été retirées de la spécification correspondante avant d'être implémentées par un navigateur.
• Des articles abordant des techniques qui se sont avérées ensuite être des pratiques à éviter et qui ont été remplacées par de meilleures approches.
• Des articles contenant des informations qui ont ensuite été remplacés par d'autres articles, de meilleure qualité.
• Des articles avec du contenu inapproprié pour MDN.
• Des sections de MDN qui ne portent pas sur les technologies web ouvertes et qui sont un fardeau en termes de maintenance.

Pour plus d'informations sur comment supprimer des documents, voir le guide sur la création, le déplacement et la suppression des pages.

Généralement, la documentation de MDN se range dans les catégories suivantes :

• Référence
• Guide
• Glossaire
• Tutoriels

MDN est une documentation produit et pas une documentation projet ou de processus. Si un document porte sur « comment utiliser telle chose » ou sur « comment cette chose fonctionne » (où la « chose » en question est rattachée à une des catégories vues avant), il peut aller sur MDN.

Si un document porte sur « qui travaille sur le développement de telle chose » ou « planification pour le développement de telle chose », il n'a pas sa place sur MDN.

Voici des exemples de documents qui n'ont pas leur place sur MDN :

• Documents de planification
• Documents de conception
• Propositions de projets
• Spécifications ou standards
• Supports promotionnels, publicité, ou informations personnelles