Guides des bonnes pratiques

Cette section porte sur les règles d'écriture sur MDN Web Docs et contient toutes les informations détaillées pour accomplir des tâches spécifiques lors d'une contribution à MDN Web Docs : comment utiliser Markdown, comment ajouter une entrée au glossaire, comment déplacer ou supprimer des pages, et plus encore. Pour en savoir plus sur comment contribuer (via GitHub), consultez nos directives de contribution.

Note : Tout au long de cette section, nous supposons que vous avez lu les directives de contribution, que vous connaissez les dépôts mdn/content et mdn/translated-content, et que vous savez comment utiliser Git et GitHub.

Comment ajouter des images et des médias: Pour ajouter une image à un document, ajoutez le fichier image dans le dossier du document puis référencez l'image dans le fichier index.md du document en utilisant un élément <img> ou la syntaxe Markdown équivalente.
Comment documenter les erreurs JavaScript: La référence des erreurs JavaScript sur MDN Web Docs est un projet visant à aider les développeuses et développeurs web à résoudre les erreurs survenant dans la console web des outils de développement. Pour ce projet, nous avons besoin d'écrire plus de documentation sur les erreurs sur MDN Web Docs afin que les outils où les messages sont générés puissent renvoyer vers ces pages. Cet article explique comment documenter les erreurs JavaScript.
Comment documenter un en-tête HTTP: La référence des en-têtes HTTP sur MDN Web Docs documente les champs d'en-têtes HTTP. Ce sont des composants de la section d'en-tête des messages de requête et de réponse dans le protocole de transfert hypertexte (HTTP). Ils définissent les paramètres de fonctionnement d'une transaction HTTP. Cet article explique comment créer une nouvelle page de référence pour un en-tête HTTP.
Comment documenter une propriété CSS: Au fur et à mesure que les normes CSS évoluent, de nouvelles propriétés sont ajoutées. La référence CSS sur MDN Web Docs doit être maintenue à jour avec ces développements. Cet article fournit des instructions pas à pas pour créer une page de référence des propriétés CSS.
Comment écrire du Markdown: Cette page décrit comment nous utilisons le Markdown pour écrire la documentation sur MDN Web Docs. Nous avons choisi le Markdown personnalisé de GitHub (GFM) comme base, et nous avons ajouté quelques extensions pour supporter certaines choses que nous devons faire sur MDN et qui ne sont pas supportées par GFM.
Comment s'informer sur une technologie: Cet article vous fournit des informations pratiques sur la manière d'aborder la documentation des technologies.
Créer et modifier des pages: Cet article décrit comment créer, déplacer, supprimer ou modifier une page. Dans tous ces cas, il est conseillé de consulter nos directives concernant ce que nous écrivons pour confirmer si l'une de ces actions doit être entreprise et d'en discuter avec l'équipe sur le canal de discussion du MDN Web Docs avant de procéder.
Écrire et référencer une entrée de glossaire: Dans cet article, nous allons voir comment ajouter des entrées au glossaire MDN Web Docs et comment y faire référence. Nous verrons également quelques règles quant à la structure et au contenu des entrées du glossaire. Le glossaire fournit des définitions pour tous les termes, abréviations, acronymes et tout le jargon que vous pourrez rencontrer en consultant le contenu de MDN à propos du Web et du développement web.