mozilla

Revision 439593 of Règles d'étiquetage pour MDN

  • Raccourci de la révision : Project:MDN/contribuer/Règles_d_étiquettage
  • Titre de la révision : Règles d'étiquettage pour MDN
  • ID de la révision : 439593
  • Créé :
  • Créateur : FredB
  • Version actuelle ? Non
  • Commentaire
Étiquettes : 

Contenu de la révision

Une des fonctionnalités importantes de MDN qui aide les utilisateurs à trouver du contenu sont les étiquettes. Chaque page peut être étiquettée avec aucun à plusieurs étiquettes (au moins un paraît un minimum) afin d'aider à catégoriser le contenu. Il existe de nombreuses manières pour aider à organiser l'information sur MDN. Cette page va vous aider afin de savoir étiquetter efficacement les pages afin de conserver l'organisation du contenu.

Pour un guide concernant l'interface utilisateur pour modifier les étiquettes sur les pages, référez-vous à la section étiquettage dans notre guide du contributeur.

Usage des étiquettes sur MDN

Les étiquettes sont utilisées pour différentes raisons sur MDN :

Catégorisation
Quel type de document est-ce ? Est-ce une référence ? Un tutoriel ? Une page d'accueil ?
Identification du sujet
De quel sujet cet article parle ? Est-ce à propos d'une API ? Du DOM ?
État d'avancement d'une technologie
Quel est l'avancement de la technologie ? Est-elle non standardisée ? Obsolète ou dépréciée ? Expérimentale ?
Niveau de compétence
Pour les tutoriels et les guides, quel est le niveau de compétence couvert par l'article ?

Guide des types d'étiquettes

Voici un guide succinct des différents types d'étiquettes existants et de valeurs possibles pour ceux-ci.

Catégorie

L'étiquettage d'un article avec une ou plusieurs des catégories suivantes facilitera la création de page d'accueil, de tables des matières. Ces termes seront aussi utilisés par notre nouveau système de recherche afin de permettre à l'utilisateur de trouver la référence ou le guide de leur choix.

Les noms de catégories suivants sont des termes standards sur MDN.

Reference
L'article est un contenu de référence à propos d'un API, d'un élément, d'un attribut, d'une propriété ou autre sujet semblable.
Landing
Cette page est une page d'accueil.
Guide
Cet article est un guide.

Sujet

En identifiant le sujet abordé par l'article, vous aidez également à l'amélioration des résultats de recherches ainsi que la qualité des pages d'accueil et d'autres aides à la navigation.

Il existe une certaine flexibilité dans cette liste, puisque de nouveaux sujets peuvent être identifiés. Toutefois, nous tenons à ne compter dans cette liste que des noms d'APIs ou de technologies. Voici quelques exemples :

  • HTML
  • CSS
  • JavaScript (remarquez le S majuscule !)
  • Document
  • DOM
  • API (ou préférons-nous Interface Method Property ??)
  • Graphics
  • Firefox OS
  • Gecko
  • XUL
  • XPCOM
  • SVG
  • WebGL
  • Element
  • Node

En général, le nom d'une interface qui possède un certain nombre de pages liées, tel que Node (qui possède de nombreuses pages pour ces propriétés et méthodes) sont un bon exemple d'étiquette utile, tout comme l'est le nom d'une technologie. Une page à propos de WebGL peut être étiquettées Graphics et WebGL par exemple, alors qu'une page à propos de {{HTMLElement("canvas")}} peut être étiquettée avec HTML, Element, Canvas et Graphics.

État d'avancement d'une technologie

To help the reader understand how viable a technology is, we use tags to label pages as to what the status of the technology's specification is. This isn't as detailed as actually explaining what the spec is and where in the specification process the technology is (that's what the Specifications table is for), but it will help the reader judge, at a glance, whether using the technology described in the article is a good idea or not.

Here are possible values for these tags:

Non-standard
Indicates that the technology or API described on the page is not part of a standard, but is considered stable in the browser or browsers that do implement it. If you don't use this tag, the assumption is made that the article covers something that's standard. The compatibility table on the page should clarify which browser(s) support this technology or API.
Deprecated
The technology or API covered on the page has been marked as deprecated in the specification, and is expected to eventually be removed, but is generally still available in current versions of browsers.
Obsolete
The technology or API has been deemed obsolete and has been removed (or is actively in the process of being removed) from all or most current browsers.
Experimental
The technology is not standardized, and is an experimental technology or API that may or may not ever become part of a standard.
Needs Privileges
The API requires privileged access to the device on which the code is running.
Certified Only
The API only works in certified code.

Regardless of the use of these tags, you should be sure to include a compatibility table in your article!

Skill level

The skill level tag type is only used for guides and tutorials (that is, pages tagged Guide). It's used to help users whittle down tutorials based on their familiarity level with a technology, for example. There are three values for this:

Beginner
Articles designed to introduce the reader to a technology they've never used or have only a passing familiarity with.
Intermediate
Articles for users that have gotten started with the technology but aren't experts.
Advanced
Articles about stretching the capabilities of a technology and of the reader.

Putting it all together

So, with these different types of tags, you assemble them together to get the full set of tags for a page. A few examples:

A tutorial about WebGL for beginners
Appropriate tags would be: WebGL, Graphics, Guide, Beginner
Reference page for the {{HTMLElement("canvas")}} element
This should be tagged with Canvas, HTML, Element, Graphics, Reference
A landing page for Firefox OS developer tools
This should be tagged with Tools, Firefox OS, Landing

Source de la révision

<p>Une des fonctionnalités importantes de MDN qui aide les utilisateurs à trouver du contenu sont les <strong>étiquettes</strong>. Chaque page peut être étiquettée avec aucun à plusieurs étiquettes (au moins un paraît un minimum) afin d'aider à catégoriser le contenu. Il existe de nombreuses manières pour aider à organiser l'information sur MDN. Cette page va vous aider afin de savoir étiquetter efficacement les pages afin de conserver l'organisation du contenu.</p>
<p>Pour un guide concernant l'interface utilisateur pour modifier les étiquettes sur les pages, référez-vous à la section <a href="/fr/docs/Project:MDN/contribuer/Comment_aider#Ajouter_ou_mettre_.C3.A0_jour_des_.C3.A9tiquettes" title="/en-US/docs/Project:MDN/Contributing/How_to_help#Add_or_update_page_tags">étiquettage</a> dans notre guide du contributeur.</p>
<h2 id="Ways_tags_are_used_on_MDN">Usage des étiquettes sur MDN</h2>
<p>Les étiquettes sont utilisées pour différentes raisons sur MDN :</p>
<dl>
  <dt>
    Catégorisation</dt>
  <dd>
    Quel type de document est-ce ? Est-ce une référence ? Un tutoriel ? Une page d'accueil ?</dd>
  <dt>
    Identification du sujet</dt>
  <dd>
    De quel sujet cet article parle ? Est-ce à propos d'une API ? Du DOM ?</dd>
  <dt>
    État d'avancement d'une technologie</dt>
  <dd>
    Quel est l'avancement de la technologie ? Est-elle non standardisée ? Obsolète ou dépréciée ? Expérimentale ?</dd>
  <dt>
    Niveau de compétence</dt>
  <dd>
    Pour les tutoriels et les guides, quel est le niveau de compétence couvert par l'article ?</dd>
</dl>
<h2 id="Tag_type_guide">Guide des types d'étiquettes</h2>
<p>Voici un guide succinct des différents types d'étiquettes existants et de valeurs possibles pour ceux-ci.</p>
<h3 id="Category">Catégorie</h3>
<p>L'étiquettage d'un article avec une ou plusieurs des catégories suivantes facilitera la création de page d'accueil, de tables des matières. Ces termes seront aussi utilisés par notre nouveau système de recherche afin de permettre à l'utilisateur de trouver la référence ou le guide de leur choix.</p>
<p>Les noms de catégories suivants sont des termes standards sur MDN.</p>
<dl>
  <dt>
    <code>Reference</code></dt>
  <dd>
    L'article est un contenu de référence à propos d'un API, d'un élément, d'un attribut, d'une propriété ou autre sujet semblable.</dd>
  <dt>
    <code>Landing</code></dt>
  <dd>
    Cette page est une page d'accueil.</dd>
  <dt>
    <code>Guide</code></dt>
  <dd>
    Cet article est un guide.</dd>
</dl>
<h3 id="Topic">Sujet</h3>
<p>En identifiant le sujet abordé par l'article, vous aidez également à l'amélioration des résultats de recherches ainsi que la qualité des pages d'accueil et d'autres aides à la navigation.</p>
<p>Il existe une certaine flexibilité dans cette liste, puisque de nouveaux sujets peuvent être identifiés. Toutefois, nous tenons à ne compter dans cette liste que des noms d'APIs ou de technologies. Voici quelques exemples :</p>
<ul>
  <li><code>HTML</code></li>
  <li><code>CSS</code></li>
  <li><code>JavaScript</code> (remarquez le S majuscule !)</li>
  <li><code>Document</code></li>
  <li><code>DOM</code></li>
  <li><code>API</code> (ou préférons-nous <code>Interface</code> <code>Method</code> <code>Property </code>??)</li>
  <li><code>Graphics</code></li>
  <li><code>Firefox OS</code></li>
  <li><code>Gecko</code></li>
  <li><code>XUL</code></li>
  <li><code>XPCOM</code></li>
  <li><code>SVG</code></li>
  <li><code>WebGL</code></li>
  <li><code>Element</code></li>
  <li><code>Node</code></li>
</ul>
<p>En général, le nom d'une interface qui possède un certain nombre de pages liées, tel que <a href="/en-US/docs/Web/API/Node" title="/en-US/docs/Web/API/Node">Node</a> (qui possède de nombreuses pages pour ces propriétés et méthodes) sont un bon exemple d'étiquette utile, tout comme l'est le nom d'une technologie. Une page à propos de WebGL peut être étiquettées <code>Graphics</code> et <code>WebGL</code> par exemple, alors qu'une page à propos de {{HTMLElement("canvas")}} peut être étiquettée avec <code>HTML</code>, <code>Element</code>, <code>Canvas</code> et <code>Graphics</code>.</p>
<h3 id="Technology_status">État d'avancement d'une technologie</h3>
<p>To help the reader understand how viable a technology is, we use tags to label pages as to what the status of the technology's specification is. This isn't as detailed as actually explaining what the spec is and where in the specification process the technology is (that's what the Specifications table is for), but it will help the reader judge, at a glance, whether using the technology described in the article is a good idea or not.</p>
<p>Here are possible values for these tags:</p>
<dl>
  <dt>
    <code>Non-standard</code></dt>
  <dd>
    Indicates that the technology or API described on the page is not part of a standard, but is considered stable in the browser or browsers that do implement it. If you don't use this tag, the assumption is made that the article covers something that's standard. The compatibility table on the page should clarify which browser(s) support this technology or API.</dd>
  <dt>
    <code>Deprecated</code></dt>
  <dd>
    The technology or API covered on the page has been marked as deprecated in the specification, and is expected to eventually be removed, but is generally still available in current versions of browsers.</dd>
  <dt>
    <code>Obsolete</code></dt>
  <dd>
    The technology or API has been deemed obsolete and has been removed (or is actively in the process of being removed) from all or most current browsers.</dd>
  <dt>
    <code>Experimental</code></dt>
  <dd>
    The technology is not standardized, and is an experimental technology or API that may or may not ever become part of a standard.</dd>
  <dt>
    <code>Needs Privileges</code></dt>
  <dd>
    The API requires privileged access to the device on which the code is running.</dd>
  <dt>
    <code>Certified Only</code></dt>
  <dd>
    The API only works in certified code.</dd>
</dl>
<p>Regardless of the use of these tags, you should be sure to include a <a href="/en-US/docs/Project:Compatibility_tables" title="/en-US/docs/Project:Compatibility_tables">compatibility table</a> in your article!</p>
<h3 id="Skill_level">Skill level</h3>
<p>The skill level tag type is only used for guides and tutorials (that is, pages tagged <code>Guide</code>). It's used to help users whittle down tutorials based on their familiarity level with a technology, for example. There are three values for this:</p>
<dl>
  <dt>
    <code>Beginner</code></dt>
  <dd>
    Articles designed to introduce the reader to a technology they've never used or have only a passing familiarity with.</dd>
  <dt>
    <code>Intermediate</code></dt>
  <dd>
    Articles for users that have gotten started with the technology but aren't experts.</dd>
  <dt>
    <code>Advanced</code></dt>
  <dd>
    Articles about stretching the capabilities of a technology and of the reader.</dd>
</dl>
<h2 id="Putting_it_all_together">Putting it all together</h2>
<p>So, with these different types of tags, you assemble them together to get the full set of tags for a page. A few examples:</p>
<dl>
  <dt>
    A tutorial about WebGL for beginners</dt>
  <dd>
    Appropriate tags would be: <code>WebGL</code>, <code>Graphics</code>, <code>Guide</code>, <code>Beginner</code></dd>
  <dt>
    Reference page for the {{HTMLElement("canvas")}} element</dt>
  <dd>
    This should be tagged with <code>Canvas</code>, <code>HTML</code>, <code>Element</code>, <code>Graphics</code>, <code>Reference</code></dd>
  <dt>
    A landing page for Firefox OS developer tools</dt>
  <dd>
    This should be tagged with <code>Tools</code>, <code>Firefox OS</code>, <code>Landing</code></dd>
</dl>
Revenir à cette révision