Révision 433563 sur 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 : 433563
  • 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.

Ways tags are used on MDN

There are several ways tags get used on MDN:

Categorization
What type of document is it? Is it a reference? A tutorial? A landing page?
Topic identification
What topic does the article cover? Is it about an API? The DOM? Graphics?
Technology status
What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?
Skill level
For tutorials and guides, how advanced is the material covered by the article?

Tag type guide

Here's a quick guide to the types of tags and possible values for them.

Category

Tagging an article with one of these categories will help automatically constructed landing pages, table of contents pages, and the like be more accurately built. These terms will also be used by our new search system, eventually, to let the user locate reference or guide information by their choice.

The following category names are standard tagging terms used on MDN.

Reference
The article contains reference material about an API, element, attribute, property, or the like.
Landing
The page is a landing page.
Guide
The article is a how-to or guide page.

Topic

By identifying the article's topic area, you can also help to generate better search results as well as landing pages and other navigational aids.

While there's some room for flexibility here as new topic areas are identified, we try to keep these to the names of APIs or technologies. Some useful examples:

  • HTML
  • CSS
  • JavaScript (notice the capitalized S!)
  • Document
  • DOM
  • API (or do we prefer Interface Method Property??)
  • Graphics
  • Firefox OS
  • Gecko
  • XUL
  • XPCOM
  • SVG
  • WebGL
  • Element
  • Node

In general, the name of an interface that has a number of related pages, such as Node (which has many pages for its various properties and methods) makes a good topic identification tag, as does the name of an overall technology or technology type. A page about WebGL might be tagged with Graphics and WebGL, for example, while a page about the {{HTMLElement("canvas")}} element might be tagged HTML, Element, Canvas, and Graphics.

Technology status

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">Ways tags are used on MDN</h2>
<p>There are several ways tags get used on MDN:</p>
<dl>
  <dt>
    Categorization</dt>
  <dd>
    What type of document is it? Is it a reference? A tutorial? A landing page?</dd>
  <dt>
    Topic identification</dt>
  <dd>
    What topic does the article cover? Is it about an API? The DOM? Graphics?</dd>
  <dt>
    Technology status</dt>
  <dd>
    What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?</dd>
  <dt>
    Skill level</dt>
  <dd>
    For tutorials and guides, how advanced is the material covered by the article?</dd>
</dl>
<h2 id="Tag_type_guide">Tag type guide</h2>
<p>Here's a quick guide to the types of tags and possible values for them.</p>
<h3 id="Category">Category</h3>
<p>Tagging an article with one of these categories will help automatically constructed landing pages, table of contents pages, and the like be more accurately built. These terms will also be used by our new search system, eventually, to let the user locate reference or guide information by their choice.</p>
<p>The following category names are standard tagging terms used on MDN.</p>
<dl>
  <dt>
    <code>Reference</code></dt>
  <dd>
    The article contains reference material about an API, element, attribute, property, or the like.</dd>
  <dt>
    <code>Landing</code></dt>
  <dd>
    The page is a landing page.</dd>
  <dt>
    <code>Guide</code></dt>
  <dd>
    The article is a how-to or guide page.</dd>
</dl>
<h3 id="Topic">Topic</h3>
<p>By identifying the article's topic area, you can also help to generate better search results as well as landing pages and other navigational aids.</p>
<p>While there's some room for flexibility here as new topic areas are identified, we try to keep these to the names of APIs or technologies. Some useful examples:</p>
<ul>
  <li><code>HTML</code></li>
  <li><code>CSS</code></li>
  <li><code>JavaScript</code> (notice the capitalized S!)</li>
  <li><code>Document</code></li>
  <li><code>DOM</code></li>
  <li><code>API</code> (or do we prefer <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>In general, the name of an interface that has a number of related pages, such as <a href="/en-US/docs/Web/API/Node" title="/en-US/docs/Web/API/Node">Node</a> (which has many pages for its various properties and methods) makes a good topic identification tag, as does the name of an overall technology or technology type. A page about WebGL might be tagged with <code>Graphics</code> and <code>WebGL</code>, for example, while a page about the {{HTMLElement("canvas")}} element might be tagged <code>HTML</code>, <code>Element</code>, <code>Canvas</code>, and <code>Graphics</code>.</p>
<h3 id="Technology_status">Technology status</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