2005-04-25 : Cette page est la traduction française par Patrick Blanchenay du document intitulé Quality Tips for Webmasters disponible à l'adresse : http://www.w3.org/QA/Tips/. Même si le document original n'a pas valeur normative, il reste la seule référence, notamment parce qu'il est susceptible d'évoluer. Par ailleurs, des erreurs de traduction ont pu survenir.
L'objectif de cette section est d'apprendre aux personnes créant des pages Web à utiliser le service de validation HTML comme outil d'entraînement. Nous proposons aux webmasters des techniques de qualité concernant des technologies développées par le W3C comme le HTML, le CSS ou le HTTP.
Chaque astuce se présente sous la forme d'une phrase d'accroche qui renvoie à une explication plus complète.
Certaines de ces astuces ont été traduites en espagnol et sont proposées par gestion des langues avec la version anglaise ; d'autres traductions sont disponibles.
<title>
: l'élément le plus important d'une page Web de
qualité<h1>
pour le titre le plus importantalt<link>
dans votre documentclass en pensant à
la
sémantiqueTout le monde est invité à soumettre des techniques de qualité pour webmasters.
Lisez les astuces déjà proposées. Si vous pensez qu'un conseil n'est pas clair et qu'il mérite d'être modifié, vérifiez d'abord les références à la fin du document lui-même, il est possible qu'une discussion existe déjà sur la liste de distribution www-qa@w3.org à propos de ce conseil.
Écrivez un brouillon de votre conseil à partir du Modèle pour les Techniques de qualité (Quality Tips Template).
Quand vous avez écrit une astuce, envoyez un courriel à la liste de distribution www-qa@w3.org en attachant le fichier que vous avez créé.
Pendant la période de révision, un membre de la W3C QA Team ajoute votre conseil (en tant que brouillon) à la liste sur la page Techniques de qualité pour webmasters (Quality Tips for Webmasters). Votre conseil qualité passe alors une période de révision de deux semaines sur la liste de distribution.
Au terme de cette période de révision, l'auteur incorpore les commentaires et remarques, et envoie une version mise à jour à la liste www-qa@w3.org ; la QA Team vérifie que les remarques ont bien été incorporées et l'ajoute aux conseils donnés sur le validateur.
Commencez par un titre simple et accrocheur. Il faut un titre de conseil intéressant pour que le visiteur lise l'astuce complète.
Quel est le but du conseil ? Précisez-le dès le début. Vous devrez composer une petite introduction permettant de faire comprendre le but et donnant au lecteur l'envie d'aller de lire la suite.
…Avant de commencer à écrire le gros du conseil, souvenez-vous : restez concis. L'équilibre est subtil, car vous ne savez pas de quel contexte proviennent vos lecteurs et il vous faut pourtant rester bref.
Les conseils sont censés être des informations utiles et facilement utilisables, pas des spécifications techniques faisant autorité. Les conseils doivent donc suggérer et justifier tel ou tel usage, et non asséner des impératifs au lecteur.
Le verbe "devoir" peut
être utilisé dans une astuce, lorsqu'on cite une
spécification normative. Si vous l'utilisez, faites-le
clairement en utilisant les balises destinées aux citations (<blockquote>,
<q>).
Reformuler le verbiage normatif peut permettre de mieux expliquer un
concept.
Il peut être judicieux de faire référence à d'autres documents s'ils donnent de plus amples explications sur une astuce, ou s'ils donnent des techniques pour la mettre en place, etc.
Donnez quelques références (mais pas trop) à la fin de votre astuce, en expliquant succintement pourquoi les gens devraient lire ces références.
Si vous faites référence à une spécification normative, expliquez les acronymes et donnez son nom complet, avec le balisage approprié.