Aller au menu - Aller au contenu

Icône Les conseils des Validateurs

Par Avatar Sébastien de la Marck (Thunderseb) et Avatar Les Validateurs
Mise à jour : 22/05/2012
Difficulté : Facile Facile Creative Commons BY-NC-ND
1 298 visites depuis 7 jours, classé 100/786
Dans ce mini-tuto (qui fait office d'article), nous (toute l'équipe des Validateurs) avons décidé de vous donner quelques conseils pour passer avec brio la validation de votre tutoriel. :)
Retour en haut
Sommaire du tutoriel :
Icône du chapitre
Retour en haut

Le choix du sujet et du type

Un tutoriel a pour but d'expliquer quelque chose. Qui dit expliquer dit également apprendre. Un tutoriel sert donc à apprendre aux lecteurs à faire quelque chose. Ce quelque chose peut aller du maniement de l'outil Plume de Photoshop à la réalisation d'un BBCode Javascript en passant par la création d'un flux RSS avec PHP, sans oublier le placement d'une mitrailleuse fixe dans Half-Life².

Thunderseb
Bref, il peut y avoir des tutoriels dans tous les domaines. Cette définition du tutoriel est très importante ! En effet, il existe ce que l'on appelle des TEA (Trucs Et Astuces). Ces TEA ne sont pas des tutoriels, même s'ils y ressemblent. Ils n'ont pas pour but d'apprendre quelque chose à l'utilisateur. Par exemple, le classique TEA est « Comment faire un texte de feu ». Il y a juste une marche à suivre, et c'est tout. Ce TEA ne permettra à l'utilisateur que de faire des textes de feu, et rien de plus. Tandis qu'un tutoriel sur l'utilisation de l'outil Plume se révélera plus utile ; lors de détourages ou de créations de formes par exemple.

Pour résumer, il faut bien faire la distinction entre montrer quelque chose et expliquer quelque chose. Un TEA a pour unique fonction de montrer quelque chose au lecteur, et nous n'acceptons pas ce type de propositions.


N'abordez pas des choses trop simples non plus. Ça ne sert à rien d'expliquer les structures conditionnelles de PHP alors que le big-tuto de M@téo le fait, soyez logique.

Attention à la paternité



La ou les personnes qui veulent publier un tutoriel doivent en être les auteurs ! Cela veut donc dire que vous ne pouvez pas publier un tutoriel qui a été écrit par quelqu'un d'autre, même si ce tutoriel est sous licence libre ou que l'auteur a donné son autorisation préalable.


Les tutoriels qui expliquent comment utiliser un programme


Il peut très bien y avoir des tutoriels qui expliquent la manipulation de programmes assez complexes, par exemple Photoshop, GIMP, Cubase ...
Par contre, il y a deux ou trois choses très importantes à savoir avant de commencer toute rédaction :
  • Si vous voulez faire un tutoriel qui traite un sujet de ce genre, il ne faut pas qu'il ressemble à un manuel d'utilisation.
    En effet, le manuel officiel du programme sera toujours et forcément meilleur que le vôtre.
  • Il faut que le programme que vous présentiez soit "complexe". Par ceci, il faut comprendre que faire un tutoriel qui explique par exemple comment manipuler Live Messenger, ou bien Totem (un lecteur vidéo sous Linux) n'a pas beaucoup d'intérêt. Car quand l'interface homme-machine est intuitive, l'adaptation est assez aisée, et l'utilisateur n'a pas besoin de lire un tutoriel pour se familiariser avec ce programme en question (au pire s'il a une question précise, il la posera dans les forums).
  • Ces points cités précédemment ne doivent pas contredire la règle en or qui dit : "Les TEA ne sont pas acceptés".
    Même si ça concerne un programme complexe, et même si ça ne ressemble pas à un manuel d'utilisation, si votre tutoriel est du type TEA, il ne sera pas accepté.


Les vidéos dans les tutoriels


Vous avez la possibilité d'insérer des vidéos (hébergées sur YouTube ou Dailymotion) au sein de vos tutoriels. Les vidéos sont là pour illustrer des propos ou des manipulations. Dans le cas des tutoriels vidéos, c'est-à-dire ceux qui ne contiennent que des vidéos (avec ou sans textes complémentaires), nous les acceptons à certaines conditions :
  • La qualité ne doit pas être mise à l'écart et nous serons très vigilants sur ce point-là.
  • Les vidéos ne vous empêchent pas de taper sur votre clavier de temps en temps. Ainsi, écrivez au minimum une introduction et une conclusion. Vous pouvez bien entendu apporter quelques informations supplémentaires sous forme de texte.
  • Vos informations doivent être claires. Si vous parlez dans votre tutoriel, veillez à ce que le son soit correct, utilisez des réducteurs de bruit et articulez. ;)
  • Un tutoriel vidéo n'exclut pas les mises à jour. Ainsi, si un membre vous fait remarquer une erreur, vous devez être capable de modifier en conséquence la ou les vidéos et de ne pas laisser cette erreur perpétuer.

D'autres règles de bon sens s'appliquent, mais n'oubliez pas que vos vidéos doivent servir et nous n'hésiterons pas à refuser tout tutoriel qui utilise la vidéo "pour le fun" alors que du texte serait 10 fois mieux adapté. ;)
Retour en haut

Les tutoriels scientifiques

Les sciences acceptées


Image utilisateur
Le Site du Zéro Sciences est, comme son nom l'indique, destiné aux sciences. Le Larousse 2011 donne cette définition :

Citation : Sciences : Larousse 2011
Disciplines scolaires et universitaires comprenant la physique, la chimie, les mathématiques, la biologie, les sciences de la Terre (par opp. aux lettres et aux sciences humaines) : Étudiant en sciences.


Ces sciences constituent les catégories de base du Site du Zéro Sciences. Néanmoins, le site est ouvert à tous les domaines scientifiques. Les catégories seront ajoutées en fonction des tutoriels que nous recevons.

Avant de débuter un tutoriel scientifique qui ne correspond pas vraiment à la définition du Larousse 2011, demandez, via MP, l'avis d'un validateur. Sinon, reportez-vous à la partie Les sujets refusés.

Les titres des tutoriels


Beaucoup de tutoriels scientifiques portant sur des matières scolaires utilisent un titre faisant référence au système éducatif français, inconnu pour les lecteurs francophones d'autres pays (Belgique, Suisse, Québec, Maroc...). Par exemple, le titre La géométrie en 6e. Quand on sait qu'en Belgique la 6e année correspond à la Terminale, il y a de fortes chances que le lecteur belge n'y trouve pas son bonheur...

Pour pallier ce problème, le titre du tutoriel doit être généraliste, ou alors plus ciblé pour expliquer clairement de quoi le cours parlera. Dans le cas du tutoriel de géométrie, un titre correct pourrait être Les bases de la géométrie.

Les prérequis


Si votre tutoriel nécessite certaines connaissances préalables (des prérequis), il est bon de les indiquer, sous la forme d'une liste à puce, dans l'introduction du tutoriel.
Retour en haut

Les sujets refusés

Voici une petite liste de tutoriels que nous refusons.

Tutoriels plagiés


Il est fréquent de recevoir à la validation des tutoriels entièrement ou partiellement plagiés. Nous rappelons que le plagiat est un délit. En cas de plagiat, le tutoriel sera bien évidemment refusé et l'auteur du plagiat recevra un avertissement. En cas de second plagiat, un modérateur pourra se charger d'appliquer une sanction, comme un bannissement d'une quinzaine de jours.

Tutoriels dits "borderline"


Certains tutoriels sont refusés car leur sujet est tendancieux, et oscille entre légalité et illégalité. Cette barrière n'est toutefois pas clairement définie, et il est difficile de prendre position. Pour cette raison, les tutoriels aux sujets tendancieux ("borderline") sont refusés. Parmi ces sujets de tutoriels, on peut citer :
  • Le jailbreak
  • Le ROM-Hacking
  • Le changement de firmware d'un smartphone
  • L'utilisation de logiciels ou systèmes qui peuvent être détournés de façon évidente. Par exemple, BackTrack

Tutoriels sur des langages


Les tutoriels sur les langages de programmation exotiques comme le Brainfuck, le LOLCODE, Linotte... sont systématiquement refusés.

Logiciels



Installation de logiciels


Les tutoriels présentant l'installation de logiciels clients ou serveurs sont généralement refusés. Par exemple, un tutoriel sur l'installation d'un serveur Minecraft sera refusé. Il en va de même pour un tutoriel sur l'installation d'un mod, d'un plugin...

Utilisation de logiciels simples


Il est fréquent de recevoir des tutoriels qui expliquent comment utiliser des logiciels qui de base se révèlent plutôt simples, comme Paint, Windows Live Messenger, CCleaner, WinZip, iTunes, Samsung Kies... Ce genre de tutoriel est refusé. Il en va de même pour les extensions ou les addons destinés aux navigateurs, comme AdBlock Plus, NoScript...

Jeux vidéo


Les tutoriels qui décrivent et expliquent comment jouer à un jeu vidéo. Par exemple, un tutoriel sur le maniement des armes de Counter-Strike sera refusé, tout comme un tutoriel sur Dofus ou sur Minecraft.

Sujets non-scientifiques


Ce n'est pas parce qu'une matière est enseignée à l'école qu'elle est scientifique. Ainsi, les tutoriels de philosophie, de psychologie, sur les jeux en bourse... sont systématiquement refusés.
Retour en haut

La rédaction

Il faut bien vous dire que le tutoriel sera rédigé en français. Eh oui, et même rédigé dans un français relativement acceptable, c'est-à-dire sans fautes d'orthographe. Cela veut donc dire que le langage SMS, ou plutôt MSN, est totalement déprécié et votre tutoriel, s'il est rédigé en ce "langage", n'aura pas la moindre chance d'être accepté même en donnant 200 euros à chaque validateur.

Vous devez donc avoir une bonne orthographe, et si ce n'est pas le cas, faites-vous relire par une personne compétente en la matière.


Relisez-vous à haute voix pour vérifier si vos phrases ne sont pas boiteuses, car quand on écrit, on pense parfois à autre chose et on oublie des mots, ou on en écrit de trop. Cela servira aussi à déceler les phrases difficilement compréhensibles ou trop longues.

Ce dernier point m'amène donc à vous parler de la ponctuation. :)

Les virgules, c'est important ; une phrase longue sans virgules est difficilement compréhensible. Par ailleurs, je me permets de vous rappeler quelques conventions d'écriture de la ponctuation :

Nom Symbole Avant Après
Virgule , Pas d'espace Espace
Point . Pas d'espace Espace
Point-virgule ; Espace Espace
Point d'exclamation ! Espace Espace
Point d'interrogation ? Espace Espace
Deux-points : Espace Espace
Tiret − Espace Espace
Trait d'union - Pas d'espace Pas d'espace
Parenthèse ouvrante ( Espace Pas d'espace
Parenthèse fermante ) Pas d'espace Espace (sauf devant un point ou une virgule)
Apostrophe ' Pas d'espace Pas d'espace
Guillemet typographique ouvrant « Espace Espace
Guillemet typographique fermant » Espace Espace
Guillemet droit ouvrant " Espace Pas d'espace
Guillemet droit fermant " Pas d'espace Espace


Le type de guillemet dépend évidemment du logiciel avec lequel vous tapez votre texte. Word mettra certainement des guillemets typographiques, alors que le bloc-notes en mettra des droits (normal, puisqu'on s'en sert pour écrire du code).

En parlant de Word, prenez l'habitude de rédiger vos tutoriels avec un éditeur de texte conçu pour ça, comme Word, ou encore Writer de OpenOffice.org. Il vous corrigera déjà les fautes de frappe, les accents, et la ponctuation (en référence à la table ci-dessus). Si toutefois vous préférez rédiger votre tutoriel directement dans votre navigateur, utilisez le correcteur orthographique intégré. Dans le cas d'Internet Explorer, vous pouvez utiliser l'extension Speckie qui ajoute un correcteur orthographique au sein du navigateur. Dans le cas de Firefox, vous pouvez choisir un correcteur au choix. Nous vous conseillons le dictionnaire Classique qui ne tient pas compte de la réforme orthographique de 1990.

Voici également un tutoriel sur le Site du Zéro qui peut vous aider si vous avez des difficultés pour rédiger : L'orthotypographie : bien écrire pour bien être lu.
Retour en haut

La mise en forme

Un tutoriel doit être bien présenté pour que sa lecture soit agréable et sa compréhension facilitée. Et mettre un texte en forme n'est pas si simple qu'il n'y paraît. La mise en forme se constitue globalement de deux choses :
  • la position des éléments du texte les uns par rapport aux autres ;
  • l'aspect de ces éléments (en italique, en gras, dans un bloc de citation, en couleur, etc.).


Le positionnement


Le texte


Sur ce point, il y a peu à dire : l'immense majorité de votre texte est aligné à gauche, et c'est très bien comme ça. Vous pouvez de temps en temps le centrer, si vous voulez améliorer sa visibilité, ou le mettre sous un élément lui-même centré, par exemple.

Si vos paragraphes sont longs, le rendu peut être meilleur si vous justifiez votre texte.

Les images


N'hésitez pas à utiliser des images dans vos tutoriels : c'est le meilleur moyen pour rompre un peu le rythme et illustrer vos propos. Notons également que vous pouvez jouer avec le positionnement des images. En effet, le zCode propose un certain nombre de mises en position :
  • le centrage, l'alignement droit et l'alignement gauche. Utilisez-les essentiellement si vos paragraphes sont courts. Il est recommandé de centrer les images, le cas échéant ;
  • le flottement droit et le flottement gauche. Cela permet à votre texte d'encadrer l'image, le rendu est souvent bon lorsque vous écrivez des paragraphes longs (et que vos images ne sont pas trop grandes).

Par ailleurs, pensez à utiliser les miniatures lorsque vos images sont trop grandes ou trop longues à charger : pensez à ceux qui ont des petites résolutions et des connexions lentes. Souvenez-vous qu'une image est avant tout présente pour illustrer vos propos, si ces derniers sont noyés dans une masse d'images trop envahissantes, elles perdent toute leur utilité.

L'organisation des paragraphes


Vous rédigez un tutoriel, c'est-à-dire un cours, et celui-ci se doit être rédigé proprement, en créant des paragraphes. Les phrases mises à la suite des autres en passant une ligne à chaque fois ne constituent pas des paragraphes. Ce genre de disposition, en plus de ne pas être esthétique, rend la lecture difficile et peu agréable.

Vous le savez, un texte est organisé en paragraphes. Ces paragraphes s'enchaînent selon un ordre logique, et il est utile de mettre en valeur cet ordre en hiérarchisant vos propos. Utilisez les balises <titre1>Titre important</titre1> et <titre2>Titre moins important</titre2> pour créer des titres.

Si vous dressez des listes, utilisez ces balises :
Code : zCode
1
2
3
4
5
<liste>
    <puce>Élément un.</puce>
    <puce>Élément deux.</puce>
    <puce>…</puce>
</liste>

Leur rendu est nettement meilleur qu'un texte avec des tirets.

Une bonne organisation des paragraphes permet de créer un rendu qui permette de voir, même sans lire, la structure de vos explications, et c'est bien plus digeste qu'un texte de 60 lignes ininterrompues. Ne faites pas non plus un paragraphe par phrase, il faut trouver un juste milieu : un paragraphe par idée importante. Pour une meilleure lisibilité, laissez une ligne vide entre chaque paragraphe.

Les mises en emphase


Quelques rappels


L'emphase est un moyen typographique qui consiste à mettre en valeur du texte en le rendant plus visible (grâce à la mise en gras ou en italique, par exemple). Le zCode fournit énormément de balises qui permettent une mise en forme précise de vos tutoriels. Il est parfois difficile de bien les utiliser et de proposer une mise en forme cohérente.

En effet, il est fréquent de lire des tutoriels dans lesquels plusieurs balises s'accumulent (le texte est à la fois écrit en gros, en gras, en rouge et en police impact). En général, ce choix d'accumuler les emphases n'est pas bien justifié et diminue la lisibilité. Le mieux est de choisir une mise en emphase par « catégorie » d'éléments importants, et de s'y tenir tout au long du tutoriel.

Par exemple, si vous rédigez un tutoriel sur le langage PHP, et que vous décidez de mettre les noms de fonctions en gras, il faut respecter deux choses :
  1. Mettre tous les noms de fonctions en gras.
  2. Ne mettre que les noms de fonction en gras.

Ainsi, lorsque le lecteur repère un mot en gras, il sait systématiquement que c'est une fonction. Si vous mettez vos noms de variables en gras, votre lecteur aura probablement plus de mal à différencier les fonctions des variables, ce qui est dommage.

Peu importe quelle mise en forme vous choisissez, l'important est d'être cohérent au sein de votre tutoriel.

Les emphases conseillées


Le zCode fournit beaucoup de balises, ce qui permet une grande liberté de mise en forme. Sachez toutefois que certaines sont plus adaptées dans des cas précis, alors utilisez-les à bon escient ! ;)

Notamment, lorsque vous écrivez du code au sein d'une ligne, utilisez la balise <minicode type="nomDuLangage">[Votre extrait de code.]</minicode>. Cela permet d'activer la coloration syntaxique.

Si, dans le même tutoriel, vous indiquez des noms de fichiers et de dossiers, ou des chemins, utilisez (par exemple) la police courrier. Si vous décidez d'écrire vos chemins d'accès en police courrier, alors ne vous servez plus de cette police pour autre chose. Inutile également de cumuler les balises : si vous utilisez une police différente, cela suffit, ne mettez pas, en plus, de l'italique ou de la couleur.

Évitez d'utiliser les symboles typographiques pour mettre en emphase certains éléments. On voit parfois certains auteurs encadrer certaines explications des guillemets. Certes, ça permet de mettre les explications en valeur, mais ils ne sont pas faits pour ça. Utilisez de préférence la mise en gras ou en italique.

Au fond, peu importent les choix que vous faites pour mettre en forme votre tutoriel, s'il y a une seule règle à retenir, c'est la cohérence : la mise en forme doit être la même tout au long du tutoriel. Un même élément doit toujours être mis en emphase de la même manière, et cette emphase lui est réservée.

La ponctuation et la typographie



Ponctuation et smileys


Même si cela peut paraître évident pour la plupart d'entre vous, nous vous rappelons que bien ponctuer un tutoriel est indispensable pour le rendre compréhensible. En particulier, les smileys ne remplacent en aucun cas la ponctuation. Ils viennent en supplément, et il est préférable de les placer après la fin de la phrase.
Citation : Ce qui est incorrect

Bonjour les Zéros :)
Bonjour les Zéros :) .

Citation : Ce qui est correct

Bonjour les Zéros. :)


Quelques rappels typographiques


Les règles de ponctuation ayant déjà été traitées, nous ne reviendrons pas dessus. Il reste toutefois un point un peu délicat à traiter : celui des énumérations (également appelées listes). Il faut discerner deux cas :
  • premièrement, votre liste est introduite par une phrase (on parle également de phrase introductive ouverte). Dans ce cas, le premier mot de la liste ne commence pas par une majuscule. Qui plus est, chaque élément de la liste est conclu par un point-virgule. Seul le dernier élément de l'énumération se termine par un point, car il termine la phrase.
    Citation : Exemple

    Voici une liste introduite par une phrase :
    • premier élément (point-virgule à la fin) ;
    • deuxième élément (toujours un point-virgule, et toujours pas de majuscule au premier mot) ;
    • dernier élément (avec cette fois un point).
  • deuxièmement, votre liste n'est pas introduite par une phrase (on parle également de phrase introductive fermée). Dans ce cas, chaque élément constitue en lui-même une phrase ; le premier mot commence donc par une majuscule et le dernier mot est suivi d'un point.
    Voici une liste introduite par une phrase, mais cette dernière se termine par un point.
    Citation : Exemple
    • Premier élément (point à la fin).
    • Deuxième élément (toujours un point, et toujours une majuscule au premier mot).
    • Dernier élément (et encore un point :D ).

Autres artifices de mise en page



Les blocs informatifs


Les blocs Information, Question, Erreur et Attention sont là pour alerter ou informer le lecteur. Si vous en abusez, ils perdent tout leur sens. Ne les utilisez que quand ils sont réellement utiles. ;)

Les tableaux


Vous pouvez utiliser des tableaux pour structurer des listings, des listes d'attributs, des fonctions. Ils sont d'une utilisation assez facile, bien plus facile que les tableaux BBCode et Wiki. Dans tous les cas un tableau sera plus beau qu'une liste mal foutue. ^^

Définitions et citations


Citation : Ma prof de français
Citez vos sources, nom d'un chien !


Si vous donnez une définition, mentionnez la provenance de celle-ci, au moyen d'un bloc de citation.

Vous pouvez aussi utiliser la balise très méconnue qu'est Wikipédia : Pour plus d'informations : <lien type="wikipedia" url="ruby">voyez Ruby</lien>, qui donne :

Citation : Définition
Pour plus d'informations : voyez Ruby
Retour en haut

La présentation des codes

Si vous rédigez un tutoriel exposant des codes sources, il est important de bien présenter ces derniers. C'est très important car un code bien présenté et proprement indenté est un code facile à lire et à comprendre.

Les sources HTML et XHTML



Les codes HTML présentés dans les tutoriels doivent être valides et correspondre au doctype défini (dans le cas d'un code complet). Il est également important d'indenter proprement le code pour en faciliter la lecture.

A ne pas faire :


Code : HTML - A ne pas faire
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<html>
<head>
<TITLE>Exemple de code</TITLE>
<script language="JavaScript" src="demo.js"></script>
</head>
<body>
<div ID=all>
<center>Texte centré</center>
<IFRAME src="demo.html" width="100%"></IFRAME><img align='right' src='demo.gif' />
</div>
</body>
</html>


Il n'y a pas de doctype, c'est un mélange de HTML et de XHTML avec des balises obsolètes (CENTER et IFRAME)... bref, c'est mauvais et ce genre de code est refusé !

Code propre accepté :


Code : HTML - Code propre
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xml:lang="fr" xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    <title>Exemple de code</title>
    <script type="text/javascript"src="demo.js"></script>
</head>

<body>
    <div id="all">
        <div class="center">Texte centré</div>
        <!-- IFRAME n'est pas valide -->
        <img src="demo.gif" alt="Attribut ALT obligatoire" />
    </div>
</body>
</html>


Le code est bien indenté, correspond bien au doctype, bref, ce code est acceptable. :)

Comme le HTML5 est en bonne voie et commence à entrer en application, vous pouvez présenter du code dans cette norme. Voici un exemple de base :

Code : HTML - Exemple de code HTML5
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>Exemple de code HTML5</title>
    <script src="demo.js"></script> <!-- Pas besoin d'attribut TYPE en HTML5 s'il s'agit de Javascript -->
</head>

<body>
    <section>
        <p>Contenu [...]</p>
    </section>
</body>
</html>


Les codes source



Votre code doit être bien indenté, que ce soit du CSS, du Javascript, du C ou du Ruby. Dans tous les cas une présentation optimale garantit une lecture et une compréhension optimales. Vous pouvez bien sûr indenter le code comme vous le désirez (K&R, BSD/Allam...), du moment que c'est lisible. Les codes compressés (Fonction Javascript écrite sur une seule ligne pour alléger le fichier par exemple) sont bien sûr proscrits.

Code accepté


Code : PHP - Code accepté
1
2
3
4
5
6
7
8
9
<?php
while ($donnees = $requete->fetch(PDO::FETCH_ASSOC)) {
    if ($donnees['id'] == 1) {
        echo 'Valide';
    }
    else {
        echo 'Non valide';
    }
}


Vous pouvez aussi commenter vos codes. Mais attention, trop de commentaires tuent les commentaires ! Si vous mettez des commentaires, mettez le strict nécessaire, sinon vos codes pourraient se retrouver noyés dans cette masse d'explications. ;)

Codes PHP



Les codes PHP doivent être soumis aux mêmes exigences que tous les codes (indentation, commentaires...). Il y a cependant quelques exigences supplémentaires :

Balises <?php



Tous les codes PHP doivent commencer par <?php sinon le code PHP ne sera pas coloré !

API utilisée pour se connecter à la BDD



Il est fortement conseillé d'utiliser l'API PDO pour se connecter à la BDD. Un cours à ce sujet est disponible dans le tutoriel de M@teo21 sur le PHP.

Gestion des erreurs SQL



Il est important d'ajouter or exit(print_r($db->errorInfo(), true)) à la fin des requêtes de manière à détecter simplement les erreurs ($db étant une instance de PDO) :

Code : PHP - Détection et détails d'une erreur
1
2
<?php
    $retour = $db->query('SELECT id, titre, contenu FROM news ORDER BY id') or exit(print_r($db->errorInfo(), true));


Cette méthode peut s'avérer un peu lourde du fait qu'on doit réécrire ce code à chaque fois. Il est donc conseillé d'utiliser la méthode PDO::setAttribute() afin d'émettre automatiquement une alerte ou une exception à chaque fois qu'une requête a échoué. Exemple :

Code : PHP - Détection automatique des erreurs
1
2
3
<?php
    $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING);   // Lance une alerte à chaque requête échouée
    $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); // Lance une exception à chaque requête échouée


Protection contre les injections SQL



Il faut aussi veiller à la sécurité des codes et notamment protéger les scripts contre les injections SQL. Cette sécurité est apportée nativement si vous utilisez les requêtes préparées. Exemple :

Code : PHP
1
2
3
4
5
6
7
<?php
    $requete = $db->query('INSERT INTO ma_table SET nom = :nom, age = :age');
    
    $requete->bindValue(':nom', $nom);                       // Protège une chaîne de caractères
    $requete->bindValue(':age', (int) $age, PDO::PARAM_INT); // Insère un nombre entier
    
    $requete->execute();


Les portions de code "inline"



Il peut être intéressant de placer des portions de code au sein d'une phrase. C'est pour satisfaire cette demande que le balise MINICODE a été créée :

Code : zCode
1
La boucle <minicode type="javascript">while (plop != "string")</minicode> est exécutée jusqu'à ce que <minicode>plop</minicode> vaille <minicode>string</minicode>.



Ce qui donne :

La boucle while (plop != "string") est exécutée jusqu'à ce que plop vaille string.
Retour en haut

Les images et les zUploads

Mettez des images



N'hésitez pas à inclure des images dans votre tutoriel. Si vous réalisez de captures d'écran, pensez à les soigner, avec un découpage correct, et évitez les images mal cadrées, pixelisées (taux de compression trop haut).

Pour réaliser vos captures, sous Windows Vista et Seven, et conserver l'ombrage des fenêtres, vous pouvez utiliser le logiciel WinSnap, malheureusement payant (PS : si vous connaissez un équivalent gratuit, faites moi signe ;) ).


Voici une capture faite avec WinSnap :

Image utilisateur


Et une autre faite avec l'utilitaire de capture d'écran de Windows (ou la plupart des logiciels de capture gratuits) :

Image utilisateur


La différence est transcendante. :)

Du côté de Linux, il existe le logiciel Shutter.

Hébergez vos images sur le Site du Zéro




Vous devez héberger vos images sur le Site du Zéro, c'est impératif. Comme ça, elles resteront toujours présentes au côté du tutoriel (si ce n'est pas mignon ça Image utilisateur ) !



Au secours, j'ai atteint mon quota, que faire ?


Je sais, c'est assez râlant ça ! :colere2:

Faites vos images et vos screenshots en .gif ou en .png indexé. Grâce à cela, vous gagnerez déjà un peu de place. Évitez tant que possible le format .jpg, les images produites sont souvent plus volumineuses (à moins d'être bien compressées).

Pour ces 2 formats, .gif et .png, vous pouvez également réduire le nombre de couleurs. N'oubliez pas que vous faites un tutoriel, pas une image .tiff en haute résolution. L'image doit être lisible, et si elle est légèrement pixelisée, ce n'est pas grave. :)


Pour finir, avec les zUploads, pensez aux miniatures. Pour rappel, c'est le petit bouton Image utilisateur.

Ah oui, j'en profite pour vous dire que vous pouvez aussi utiliser l'attribut legende dans vos balises image. Son contenu remplacera le traditionnel « Image utilisateur » (l'attribut HTML alt).


Code : zCode
1
<image legende="bannière SDZ">http://www.siteduzero.com/Templates/images/designs/19/logo_sdz_fr.png</image>

Retour en haut

La validation

Avant




Vérifiez l'orthographe



Avant d'envoyer votre tutoriel à la validation, relisez-le ! Nous sommes des validateurs de tutoriels, nous validons le contenu du tutoriel. Ce n'est pas notre rôle de corriger les fautes d'orthographe, de ponctuation et de syntaxe !

Si vous êtes nul en orthographe, demandez à vos parents (ou à n'importe qui de plus doué que vous ^^ ) de relire le tutoriel. Si nous recevons le tutoriel plein de fautes, nous allons vous le refuser pour mauvaise orthographe.

Vérifiez les critères d'acceptation



Avant d'envoyer votre tutoriel, vérifiez qu'il respecte les critères suivants :

  • Vous avez fait un MINI-TUTO : Le mini-tuto doit être achevé.
  • Vous avez fait un BIG-TUTO : Le big-tuto doit contenir au moins 3 mini-tutos consécutifs et doit fournir une base au lecteur. Cela veut donc dire que le tuto doit être bien avancé ! Par exemple, si le tuto est composé de 3 mini-tutos : un sur l'introduction, un sur le contenu, et un en annexe, les mini-tutos d'introduction et d'annexe ne sont pas pris en compte !

Si vous ne respectez pas ces règles, le tutoriel sera immédiatement refusé sans être lu !


Message de validation



Lors de l'envoi du tutoriel à la validation, vous devez remplir un champ de texte. Ce champ vous sert à passer un message au validateur qui lira votre tutoriel. Vous pouvez y inscrire ce que vous voulez, mais surtout, pensez à y inscrire des informations sur votre tutoriel (vous n'êtes pas sûr de la catégorie, précisions à apporter...). C'est très important surtout pour les mises à jour des tutos. Dans ce cas, vous utiliserez ce champ pour indiquer l'objet de la mise à jour.

Pas bien :

ben j'ai corrigé 2/3 fautes et une sous partie


Bien :

J'ai corrigé les fautes d'orthographe signalées dans les commentaires et j'ai modifié dans la sous partie Pour aller plus loin la conclusion en ajoutant quelques liens de sites qui traitent du sujet, mais de façon plus avancée.
Merci. :)


Pendant



Il est fort possible que votre tutoriel soit refusé. Le validateur qui vous l'a refusé vous expliquera pourquoi dans un MP (que vous recevrez par l'intermédiaire de Zozor).

Prenez en considération les commentaires du validateur. Une fois les modifications demandées effectuées, reproposez votre tutoriel. Il est inutile de préciser quel validateur a refusé le tuto et pour quelles raisons. En effet, nous voyons tous les commentaires des validateurs ainsi que les vôtres.

Cela dit, essayez d'être le plus complet possible dans vos commentaires : « J'ai fait ceci, ça, j'ai retravaillé cela et ceci »

Après



Si votre tutoriel est enfin accepté :) , vous recevrez les commentaires ajoutés sur votre tutoriel par les membres via un MP de Zozor. Prêtez-y attention. Soit ils sont sympa et là, aucun problème, soit ils sont négatifs, et là, il y a problème. Tâchez de modifier votre tutoriel en conséquence. ;)

Vous devez aussi repasser par la validation pour valider les modifications apportées. Essayez d'être le plus complet quant aux modifications effectuées, pour faciliter le travail des validateurs. ;)
Retour en haut
Voilà, bon tutotage. ^^
Retour en haut

Partager

Retour en haut
140 commentaires pour "Les conseils des Validateurs"
Note moyenne : 3.46 / 4 (95 votes)
Pseudo Commentaire
Hors ligne youn98 # Posté le 21/12/2011 à 14:59:22
Newbie or not newbie
Avatar

Ville : Mâcon
Pays : France métropolitaine

 Ok merci :)
Programmeur HTML5/CSS3, JS, Java, PHP, C.
 
Hors ligne romain51 # Posté le 11/04/2012 à 14:31:45
Linux permet de dépanner WIND
Avatar

Ville : Sierre
Pays : Suisse
Études : EPSIC

 Pour les captures d'écran il existe le logiciel greenshot
Respect your sysadmin and your sysadmin will respect you and help you.
 
Hors ligne _random # Posté le 22/05/2012 à 20:46:17
Avatar

 Votre définition de science est complètement à chier, parce qu'elle oppose les sciences aux sciences humaines, ce qui est faux puisque celles-ci en sont un sous-ensembles.

La définition du Petit Larousse en couleurs de 1980 est bien meilleure :
Citation
Ensemble cohérent de connaissances relatives à certaines catégories de faits, d'objets ou de phénomènes.

Elle est ensuite détaillée en deux sous-définions

Citation
Science humaines, sciences qui ont pour objet de connaissance les différents aspects de l'homme et de la société, comme l'hitoire, la sociologie, la psychologie, etc.

Citation
Science naturelles, sciences constituées à partir de l'étude de la nature (botanique, géologie, zoologie, etc.).
Intelligence ||||||||||||| 130% , Amabilité |||||||||| 30%
 
Hors ligne MicroJoe # Posté le 23/05/2012 à 17:47:59
J'aime les nouilles.
Avatar
close

Au niveau des images, pourquoi ne pas prôner des outils tels que PngOptimizer pour compresser au maximum les images tout en gardant la même qualité ?
C'est ce que j'utilise pour mes tutoriels et parfois c'est impressionnant là place que l'on peut gagner !
C++, C# & Python pwred™
Python – Sérialisez vos objets au format JSON ! (en ligne)
Python – A la découverte de IronPython (en cours de rédaction)

Sciences – La mécanique de zéro (en bêta)
 
Hors ligne BurningMind # Posté le 23/05/2012 à 22:14:56
Anciennement, titragon94
Avatar

Ville : Saint maur des fossés
Pays : France métropolitaine

 Pour les sujets borderlines, je peux comprendre que le jailbrak, le ROMHacking et autre tweaks soient interdits, mais, même si une utilisation malhonnête peut en être faite, un tutoriel sur BackTrack est quand même loin d'être borderline. Un tutoriel sur un anitvirus n'est pas borderline parce qu’il apprend les faiblesses de cet antivirus. En effet, quelqu'un de malhonnête peut faire une mauvaise utilisation de quasiment tous les tutoriels qui lui tombent sous la main (un autre exemple serait Wireshark).

Je pense que ça a déjà été dis et redis, mais je trouve ça un peut bête de proscrire des tutoriels qui pourraient être très intéressants.
L'éternité c'est long, surtout vers la fin...
Image utilisateur
Image utilisateur
 

Voir tous les commentaires