Règles d'écriture

MDN Web Docs est un projet open source. Dans les sections qui suivent, nous verrons ce qui y est documenté et comment. Pour en savoir plus sur les façons de contribuer, veuillez consulter les règles de contribution.

Ce que nous documentons sur MDN

Dans cette section, nous décrivons ce qui est inclus dans MDN et ce qui n'y a pas sa place, ainsi que différentes règles, par exemple sur la chronologie à utiliser pour documenter de nouvelles technologies, le processus de suggestion et l'acceptation des liens externes. Il s'agit d'un bon point de départ si vous souhaitez écrire ou mettre à jour du contenu. Cette section contient également :

Les critères d'inclusion: Une description détaillée des critères qui définissent le contenu qui peut être inclus dans MDN, le processus pour qu'une nouvelle documentation soit ajoutée et les attentes et règles à respecter pour les parties qui voudraient contribuer.

Comment écrire pour MDN

Dans cette section, nous abordons tout ce qui est nécessaire à la création et à l'édition de pages, dont certains processus et certaines techniques que nous utilisons. Elle contient des informations pour bien démarrer, un aperçu général de la structure des pages et où trouver des guides pour les différentes tâches d'écriture. Cette section contient notamment les articles suivants :

Utiliser le format Markdown: Le format de Markdown que nous utilisons est un dérivé du GitHub flavored markdown (GFM). Cette section est un guide pour ce format utilisé sur MDN, détaillant entre autres certains composants spécifiques comme les notes et les listes de définitions.
Ajouter des images et des médias: Cette section décrit les prérequis à respecter pour ajouter des médias aux pages, comme des images.
Ajouter une entrée au glossaire: Cette section explique comment ajouter de nouvelles entrées au glossaire MDN et utiliser des liens vers ces termes. Elle fournit également des recommandations quant au plan et au contenu à respecter pour chaque entrée.
Comment effectuer des recherches sur une technologie: Cette section fournit des conseils pratiques pour effectuer des recherches à propos d'une technologie en cours de documentation.
Comment déplacer et supprimer des pages: Cette section explique comment déplacer ou supprimer une page.

Notre guide stylistique

Le guide stylistique couvre les formes et styles que nous utilisons pour écrire sur MDN. Il aborde également le format à respecter pour les exemples de code.

Types de page sur MDN Web Docs

Chaque page de MDN a un type spécifique, qu'il s'agisse d'une page de référence CSS ou d'une page du guide JavaScript. Cette section liste les différents types de page et fournit des modèles pour chaque type. N'hésitez pas à parcourir ces modèles pour comprendre le type de page que vous rédigez.

Structures des pages sur MDN Web Docs

Cette section détaille les différentes structures de page que nous utilisons afin de fournir des informations de façon cohérente. Cela inclut :

Les exemples de code: Il existe plusieurs façons d'inclure des exemples de code sur des pages. Cette section les décrit et fournit des règles de syntaxe pour les différents langages.
Les macros: Les macros sont des raccourcis qui sont utilisés sur les pages pour générer du contenu comme les barres latérales de navigation. Cette section énumère les macros utilisées et leur résultat.

Comment qualifier une technologie

Dans cette section, nous définissons les termes obsolète, déprécié, et expérimental et fournissons des règles pour savoir quand retirer du contenu de MDN.

Attributions et information sur les licences utilisées

Cette section décrit la licence utilisée pour le contenu et les règles à respecter pour attribuer le contenu correctement.