Rédaction d’un tutoriel¶

Texte utilisé jusqu’à présent dans la première section des tutoriels TYPO3 :

« Ce document est un tutoriel. Les tutoriels sont conçus pour être des instructions étape par étape spécialement créées pour guider un débutant à travers une tâche particulière du début à la fin. Pour faciliter un apprentissage efficace, les tutoriels fournissent des exemples pour illustrer les sujets qu’ils couvrent. En outre, des tutoriels fournissent des conseils sur la façon d’éviterles pièges communs et mettent en évidence les concepts clés dont il convient de se souvenir pour référence future. »

En examinant la littérature mentionnée ci-dessous, nous devrions considérer les points clés suivants:

• un tutoriel est une leçon, orientée vers l’apprentissage, montrant les étapes pour compléter quelque chose, rendant le lecteur plus connaissable
• le lecteur doit réaliser quelque chose de significatif et connaître le succès, le trouver faisable et agréable, améliorer les compétences, gagner en confiance et veut le faire à nouveau.
• concentrez-vous sur les connaissances pratiques et non sur les connaissances théoriques. Apprenez un nouveau métier ou une nouvelle compétence, concentrez-vous sur l’apprentissage en suivant les directives

:

• permettre à l’utilisateur d’apprendre en faisant,
• passer du simple au complexe
• Démarrer l’utilisateur
• il est correct de montrer les étapes que le débutant comprend le mieux. la « meilleure pratique » peut être quelque chose de différent. La façon dont un utilisateur expérimenté le ferait peut être différente.
• Le but est de faire démarrer le lecteur, pas de le conduire à une destination finale.
• Assurez-vous que votre tutoriel fonctionne!
• inspirer la confiance du débutant: dans le logiciel, dans le tutoriel, dans le tuteur et, bien sûr, dans leur propre capacité à réaliser ce qui leur est demandé.
• Assurez-vous que l’utilisateur voit immédiatement les résultats
• La conclusion de chaque section d’un tutoriel, ou du tutoriel dans son ensemble, doit être une réalisation significative.
• Votre tutoriel doit être répétable de manière fiable.
• Concentrez-vous sur des étapes concrètes et non sur des concepts abstraits. La tentation d’introduire l’abstraction est énorme : résistez !
• Fournir l’explication minimale nécessaire
• Se concentrer uniquement sur les étapes que l’utilisateur doit suivre