Forums GAMERGEN

[Guide] Outils d’aide à la rédaction d’un tutoriel

[Guide] Outils d’aide à la rédaction d’un tutoriel

Message non lupar AmNesTy » 11 Mai 2013, 11:21

Image

[Guide] Outils d’aide à la rédaction d’un tutoriel



  • Introduction

Dans ce post, vous trouverez tout le nécessaire pour créer et rédiger un bon tutoriel.
Mais avant de commencer, n’oubliez pas d’aller consulter les règles de la section.

Pour rappel, un tutoriel est un guide permettant d’aider l’utilisateur novice à se former de manière autonome. Il est construit à partir d’instructions détaillées pas à pas, le plus souvent par étape.



1) La structure

La structure est la clé de voûte de votre tutoriel. Elle est capitale pour assurer la lisibilité de celui-ci.
Elle représente l’organisation chronologique de vos idées. L’idéal étant de commencer par les instructions de base pour aboutir sur les instructions les plus élaborées. Cette technique bien connue des enseignants est appelée l’apprentissage progressif.

Pour que votre structure soit bien construite, il faut également que vos titres soient les plus explicites possibles. Ils doivent être le reflet de vos parties/sous-parties pour faciliter la localisation de l’information. Pensez également à ajouter une numérotation.



2) La rédaction

La rédaction est une partie délicate. Elle permet aux lecteurs de comprendre l’information.
Vous maitrisez probablement déjà bien le sujet du futur tutoriel que vous allez rédiger mais ne perdez pas de vue qu’il sera destiné à des lecteurs de différents niveaux. Un débutant ne percevra pas forcément vos informations de la même manière qu’un membre averti.
Ça ne veut pas non plus dire que vous allez devoir rédiger des « pavés » pour que l’information soit comprise de tous, au contraire ! Il faut éviter d’en dire trop car vous risquez de perdre vos lecteurs dans des détails insignifiants. L’idéal, c’est d’être le plus clair et le plus concis possible. A vous de hiérarchiser l’information pour n’en faire ressortir que les points importants. Malgré tout, il faut que ça reste cohérent. Votre objectif est donc de trouver le bon équilibre entre l’exhaustivité et la concision.

Dans votre rédaction, vous allez très certainement faire appel à des termes alambiqués. N’hésitez pas à les définir si vous jugez que c’est utile. Pour vous aider, un lexique des termes utilisés dans le monde d’Android est disponible à cette adresse.

Parce que des images valent mieux que des mots, illustrez vos propos. Les photos peuvent s’avérer bien plus pertinentes que les longs paragraphes. Elles permettent d’accompagner vos lecteurs dans les manipulations à effectuer. Elles sont donc très importantes, ne les négligez pas.
Attention à ne pas en faire trop tout de même. Un tutoriel constitué exclusivement de screenshots n’est pas approprié pour guider les utilisateurs.

N’oubliez pas de vous mettre à la place du lecteur afin de rédiger vos idées de la façon la plus adaptée possible. Certes, la pédagogie est une faculté mais en vous mettant au niveau de celui qui apprend, vous parviendrez plus facilement à vos attentes.



3) La mise en forme

La mise en forme permet de faire ressortir les informations essentielles mais aussi de rendre votre tutoriel plus lisible.
Pour mener à bien votre travail, vous avez à votre disposition des balises BBCode. Pour en savoir plus sur les différentes possibilités qu’offre ce langage PHP, vous pouvez consulter ce tutoriel.

Pour améliorer toujours plus la clarté de votre didacticiel, aérez votre contenu. L’idéal étant d’affecter une idée par paragraphe. Ça permet ainsi d’éviter de rédiger des paragraphes trop longs.

Il est conseillé d’utiliser les spoilers lorsque vous insérez des longs textes ou des grandes images. L’intérêt de cette fonctionnalité étant de permettre à l’utilisateur de choisir quand est-ce qu’il veut afficher le contenu supplémentaire.

Afin que le lecteur ait une aide visuelle supplémentaire, vous pouvez ajouter de la couleur dans votre tutoriel. Attention tout de même, cette fonctionnalité doit être utilisée avec parcimonie.


.
4) Quelques conseils supplémentaires...

  • Faire une introduction
    Commencez votre tutoriel par une courte introduction. Celle-ci doit informer le lecteur de manière synthétique des différentes actions qu’il est possible de réaliser à travers votre didacticiel.

  • Faire un Plan
    Ne vous lancez pas tête baissée dans la rédaction d’un tutoriel sans avoir au préalable aménagé le terrain.
    Faites un plan avec des parties et des sous-parties.

  • Se relire
    Parce qu’un article rempli de fautes n’est vraiment pas agréable à lire, relisez-vous ! Ca évitera les soucis d’incompréhensions mais aussi les critiques des membres.

  • Se faire aider
    Personne n’est parfait et vous ferez très certainement des fautes d’orthographes / de syntaxes que vous ne verrez pas forcément même après plusieurs relectures. C’est pour cela qu’il est très utile d’avoir un regard extérieur sur votre travail.

  • Prendre son temps
    Ce n’est pas une course de vitesse ! Prenez votre temps. Revenez-y quelques jours après à tête reposée.

  • Accepter la critique
    Ne vous attendez pas à des remerciements par centaine. La plupart du temps, ce sont les personnes mécontentes qui vous donneront leurs avis.
    Malgré tout, il faut apprendre à accepter les critiques constructives. C’est elles qui vous permettent d’aller de l’avant et ainsi de vous améliorer. On apprend plus de nos erreurs que de nos succès.
    Pour ce qui est des critiques non constructives, le mieux est de les ignorer ou de les signaler aux modérateurs.



  • En conclusion...

La rédaction d’un tutoriel n’est pas une tâche facile mais ce n’est pas non plus la mer à boire. Si vous respectez ces quelques conseils, vous ne devriez pas avoir de problème...
AmNesTy Ancien
Ancien
Messages: 2194
Inscription: 28 Jan 2012, 14:56
Pays: France
Sexe: Homme

 

Retourner vers Vos tutos et astuces Android