yo dawg i heard you like tutorials

Le mode d’emploi ultime pour faire un bon guide d’utilisation dans tous les domaines.
Bien que tutoriel désigne un Programme de présentation qui guide l’utilisateur dans l’apprentissage et la mise en œuvre d’un matériel ou d’un logiciel. nous aborderons une application plus générale du terme, regroupant tout guide d’utilisation.
Ce qui suit regroupe ce que j’attends en lisant un tuto, bien que j’en écrive sur ce même blog qui ne prennent pas toujours toutes les qualités indiquées ci-après.

Rédiger en sûreté


donc, dans un logiciel qui ne vous fera pas perdre votre travail si il y a une coupure de courant ou que votre petit frère/votre chat/votre labrador vient rédiger avec vous en sautant sur le clavier.
Sauvegarder régulièrement. Ctrl+S est votre ami.
J’utilise la plateforme de blog Dotclear (et wordpress pour qzine.fr)une extension de firefox nommée Lazarus form recover pour garder en mémoire ce que j’écris. Plus de souci de perte d’écrits si je valide un formulaire ou un billet de blog et que le serveur cible décide de ne pas faire son travail.
Pour sauvegarder j’enregistre mes billets en mode hors ligne avant de les publier pour pouvoir les corriger. Méfiez vous des différences entre é et er. Toute confusion entre les deux vous identifiera comme kikoolol, et c’est encore pire si vous vous prenez au sérieux. On risque de s’attendre à ce que vous soyez un clone de celui qui dit “T’AS VU MA CASQUETTE?” (plus connu sous le nom de RealMyope) Et franchement, ça me fait saigner les yeux quand je croise une erreur pareille sur un journal ou n’importe quel écrit censé (et non sensé) faire preuve d’analyse sérieuse. Surtout quand je regarde un tuto avec du code dedans. Je me dis que si le type est pas capable d’écrire correctement y’a peu de chances que les scripts qu’il a écrit soient fiables ou exemplairement bien faits.
Firefox a la décence de souligner en rouge les mots qu’il repère comme mal orthographiés. Ce qui est plutôt sympa et évite d’ouvrir un autre logiciel pour rédiger.

Illustrer


en images et en exemples de toutes sortes. Prendre un paradigme pour servir de fil rouge et s’y tenir.
Une image permettra de mieux faire voir une idée et de la retenir.

Concrétiser


Si vous voulez faire comprendre le fonctionnement d’une base de données, mettez la en contexte d’une utilisation dans une bibliothèque municipale qui aurait besoin de savoir quels livres sont empruntés ou non, afin d’envisager des cas de figure qui donneront lieu à des utilisations en pratique.
Pour être apprise et surtout retenue, une chose doit être non seulement utile mais surtout utilisée.

Prévoir des questions, répondre à votre lectorat


Quand vous donnez des exemples en comparant les bons et les mauvais, mettez l’accent sur les bonnes pratiques pour qu’elles soient mieux intégrées.

Déterminer l’expertise de la cible

horacio l'expert
Ne tombez pas dans le piège du tutoriel expliquant des choses avec un niveau de compétences tellement complexe que ceux qui ont ces compétences n’apprendraient jamais rien en le lisant.
On ne s’attend pas à ce qu’un lycéen fan de marijuanna ait les mêmes connaissances en neurobiologie qu’un chirurgien fan de tartouff ayant BAC+10. (vous noterez qu’il n’y a qu’une seule différence) carte des pains au chocolat et chocolatines
On ne sait pas si notre lectorat mange des chocolatines ou du pain au chocolat. Perso, venant de Haute Normandie je suis aux pains au chocolat. Et il est vrai que la nougatine n’est pas du pain au nougat.
Plus que tout, n’utilisez pas d’abbréviations sans les avoir données en version longue au moins une fois. (un travers retrouvé dans de nombreux écrits) La confusion provoquée dans l’esprit de vos lecteurs ne leur fera que confirmer que vous n’avez que faire d’être compris. Et ça c’est insultant, m’voyez.
Heureusement sur internet vous disposez d’une balise d’abbréviation permettant d’en donner la signification au survol du curseur.
Alors sachez que si vous faites un tuto sur la perspective en dessin il ne faudra pas parler d’espace courbe avant d’avoir abordé l’espace plan.
sur le site du zéro, le zéro c’est vous. Partant d’une connaissance nulle et désireux d’apprendre (ici des langages informatiques et des logiciels de graphisme)c’est le lieu idéal pour faire vos premiers pas. Par la suite vous saurez fouiller vous même les documentation sans en avoir peur.

la collection de livres “pour les nuls” (for dummies) fait de même dans des thèmes très variés.

Notez donc les prérequis en début du tuto s’il y en a. Comme “savoir faire revenir des oignons, ou avoir des connaissances en PHP”.

Se documenter


google et wikipédia vous aideront. On vous dira sûrement que wikipédia regorge de bétises. On vous répondra “non” quand vous demanderez à ces mêmes personnes si elles contribuent à wikipédia. Notez l’ironie. Enfin, n’hésitez pas à varier votre documentation et ne croyez pas que parce qu’un texte est sur écran il est forcément plus débile que sur papier. Pensez à consulter au hasard la bibliothèque de vos parents, ou a traîner dans les librairies et autres FNAC pour profiter des recherches d’autres personnes plus ou moins qualifiées dans ce qui vous intéresse pour votre tuto.


Chronologie


Les professeurs des écoles le savent bien, on ne lit jamais toutes les questions avant de commencer à y répondre.
Dans un tuto, on est là pour apprendre et surtout pour pratiquer.
Aussi rigoureusement que pour une recette de cuisine, ne faites surtout pas de flashback dans un pas à pas. Une formulation confuse pourrait être fâcheux et gâcher tout le fun. Autant que dans ces histoires de SF où se multiplient les noms inutilement imprononçables. Comme dans le strip de Boulet où une monture au nom étrange ne cesse de changer de forme au fil de la lecture faute de description utile.

Cibler notre sujet.


préciser le contexte, le but recherché, le métier concerné, l’environnement de travail, et ce qui n’est pas ciblé.

Hiérarchiser, ordonner, faire des listes.


utiliser des captures d’écran, les annoter si nécessaire. faire une vidéo de démonstration de 5 minutes. Utiliser des outils de capture vidéo.
Si un article comporte des liens il vaut mieux ne pas en mettre une tonne, car personne ne les ouvrira tous. De plus, quand vous en mettez un, placez le sur un texte évocateur.
un lien sur le mot “ici” ou “là” ne donne pas envie d’en voir plus car on ne saurait décider pourquoi des mots aussi courants nous feraient voir quelque chose digne d’intérêt.
Ne faites pas des phrases inutilement longues avec des mots inutilement compliqués si vous voulez que l’on vous suive. C’est un écueil courant dans les rédactions philosophiques et ça ne fait que montrer que vous écrivez au hasard en espérant que sur un malentendu vous aurez l’air profond comme un vrai utilisateur d’instagram. Deux phrases moyennes valent mieux qu’une longue.

“la boutique de !Q le fanzine CULturel” plutôt que seulement sur le mot “boutique”. Remarquez qu’un lien est plus facilement cliquable s’il a une surface plus grande. Si vous voulez rendre très confus votre lectorat vous pouvez placer le lien sur le mot “du”.
En résumé, écrire pour des humains et non pas pour des robots.
Des tutoriels de Search Engine Optimisation vous aideront sur ce point.

C’est l’équivalent de faire le ménage et ranger sa chambre avant d’accueillir du monde chez soi.
Disposer en paragraphes permet de rendre la lecture agréable tout en montrant qu’on sait distinguer des parties dans notre sujet. Lire un pavé n’est pas engageant à moins d’être très motivé. Vous apprendrez assez vite que l’attention du lectorat se gagne, surtout si vous suivez des cours de typographie.
Scinder un long guide en plusieurs articles courts est une bonne pratique. C’est une des raisons pour lesquelles 99% des livres comportent des chapitres.
Le rangement c’est ce qui fait que google est le meilleur moteur de recherche au monde, parce que ce n’est pas le bordel sur sa home page, et parce qu’ils ont très vite pris conscience qu’un site bordélique rend confus ses visiteurs. Et comme disait une vieille publicité avec une grande lucidité “on a pas besoin de tout, tout le temps”.


Appliquez un vrai rangement dans vos idées et tout sera plus clair pour vos lecteurs.
Je vous conseille de le faire sur papier avec un simple stylo.
Prenez votre temps. N’hésitez pas à déplacer des paragraphes et à reformuler certaines parties pour les relier.


S’impliquer personnellement


Évoquer votre démarche de raisonnement, n’ayez pas peur de donner votre propre avis, chacun à le droit d’en avoir un et c’est bien normal. Vous imaginez si tout le monde devait raisonner de la même façon pour pouvoir vivre? Si vous ne fréquentez que des gens qui pensent comme vous il est temps de vous questionner sur la notion d’honnêteté, et de votre capacité à tolérer que vous puissiez ne pas détenir la vérité ultime. La plus grosse erreur que vous puissiez faire est de penser que ce que vous tenez pour évident l’est aussi pour tout un chacun. Ce qui explique que l’on puisse expérimenter des chocs culturels réels dans des lieux portant très proches.

être poli


la politesse est importante, elle ne fait que rendre l’entente meilleure.

Tout comme avoir une grammaire correcte. Ce n’est pas pour avoir l’air de quelqu’un de précieux ou de péteux, c’est du savoir vivre en société. Être rigoureux sur son écriture c’est montrer que la réception de ce que l’on écrit nous importe. C’est montrer qu’on prend soin de nos lecteurs, qu’on a envie qu’ils se sentent bien. Une des raisons qui fait que j’ai toujours fui skyblog.

Vouvoyer


Personnellement je le prends mal quand un site web me tutoie. Sauf si c’est un site Anglais. Ayant la culture occidentale que j’ai, je trouve ça souvent très impoli si un ou une inconnue me tutoie. On n’a pas élevé les cochons ensemble. à plus forte raison dans le monde de l’écrit, être poli est capital. à moins que vous trouviez plaisant de lire des pavés de SMS et que saigner des yeux soit votre grande ambition. même sur les 140 caractères de twitter on n’écrit pas comme ça.

le Ton général


Vous voulez du LOL, vous faites dans le pathos, vous aimez les discours objectifs c’est à vous de choisir. Mais essayez de faire dans l’homogénéité (mot compte triple) si vous ne voulez que l’on vous suive. Un exemple de ton mixé qui donne du mauvais goût:

“Cher Robert, je vous présente mes sincères condoléances pour votre femme, égérie des films Emmanuelle. femme talentueuse et intelligente. mère et amie ayant initié une révolution cinématographique en incarnant une personnalité forte, donnant un visage à la révolution des moeurs de mai 68. Sa disparition est pleurée par des milliers d’âmes. Avant c’étaient des miliers de verges et de vulves qui pleuraient pour elle. Elle restera dans notre coeur.

bon sur ce on va boire un coup au dernier bar Samedi, faut que j’arrive à me faire servir un Gargle Blaster! Bisous”


conclure en résumant


un court sommaire de ce qui a été vu vous permettra de consolider les aspects abordés, les problèmes rencontrées, les différentes façons de les résoudre, et d’enchaîner sur des liens pour approfondir.

Sourcer

source la bouvaque à abbeville

mettre des liens pour approfondir le sujet


mettre un glossaire peut sauver des vies. Certains sites spécialisés dans les écritures de scripts donnent en fin de page une liste de fonctions avec leurs paramètres possibles. Une très bonne idée à étendre à d’autres domaines.
utiliser des tags dans vos articles permettra facilement de savoir ce dont parle votre tuto et dans quel contexte il s’applique.

Redirection


Si votre tuto est obsolète, donnez un lien vers une page plus récente.
Si votre site web a une nouvelle version remplaçant la dernière, faites une redirection automatique en HTML au lieu de laisser vos visiteurs croire que vous êtes porté disparu. Ou du moins, mettez un lien on ne peut plus en évidence vers le nouveau site.

Pour conclure je vous conseille d’avoir toujours avec vous un petit carnet et de quoi écrire dedans. J’ai commencé à rédiger ce tuto en notant quelques titres dans un carnet pendant que j’étais dans le train hier. La rédaction totale m’aura pris environ 4 heures de fun.
Voilà, j’espère maintenant que vous avez des outils en plus pour faire les plus beaux et utiles tutos du monde! La force soit avec vous.

Tous mes tutoriels sont dans les liens d’en-tête du site, bonne lecture. Et comme toujours si vous me conseillez des ressources pour améliorer le tout, j’en suis gourmand. :)