Un tutoriel pour faire un tutoriel

Dans ce tutoriel, vous pouvez apprendre à faire un tutoriel.

Un tutoriel est une leçon qui vous emmène par la main à travers une série d'étapes pratiques. Il offre une expérience d'apprentissage par faire quelque chose. C'est la meilleure façon de connaître un sujet que vous ne connaissez pas encore.

Les tutoriels sont cruciaux dans toute documentation: ils montrent les nouveaux arrivants, ils guident les premiers pas, ils sont la fenêtre d'achat, ils donnent une expérience agréable et facile d'un sujet. L'un des « trucs » pour obtenir cela est de laisser de côté tout ce qui peut distraire dans le processus d'apprentissage. Par exemple:

• D'autres façons de faire quelque chose ou des façons de faire quelque chose de très spécifique.
• Références complètes de toutes les options et description technique de sa structure.
• Explications détaillées et contextes historiques.

Il est préférable de fournir ces informations supplémentaires séparément. Évitez autant que possible de le mélanger, car il ne fera que brouiller le tutoriel. C'est le principe principal de la Diátaxis Cadre, un moyen systématique d'améliorer la documentation. Mettez les informations supplémentaires mentionnées ci-dessus dans respectivement des guides pratiques, des références et des explications. Dans les guides pratiques, vous pouvez rapidement trouver comment faire quelque chose de spécifique. Dans les références, vous pouvez rechercher comment les choses fonctionnent, quelles options ils ont et où trouver plus d'informations. Avec des explications, vous pouvez approfondir votre compréhension du sujet.

Bien qu'un tutoriel offre une introduction à un sujet, il ne s'adresse pas exclusivement aux débutants. Cela peut aussi être une introduction à un sujet avancé! Soyez clair au début de votre tutoriel sur les connaissances ou les compétences nécessaires pour être en mesure de faire le tutoriel.

Si vous enseignez à quelqu'un comment cuisiner, vous devez expliquer des choses comme les techniques de coupe, comment utiliser un four et d'autres trucs de cuisine de base. Vous commencez avec une recette simple, de préférence quelque chose qui donne facilement un bon produit final. Ce produit final lui-même n'est pas l'objectif principal: vous voulez enseigner certaines compétences. C'est ce que fait un tutoriel. Quelqu'un qui sait cuisiner et veut faire quelque chose de spécifique, n'a pas besoin d'un tel tutoriel, mais d'une recette. Les recettes sont les guides pratiques de la cuisine.

Étape par étape

Pour créer un tutoriel:

1. Recueillir des informations sur le sujet. Documentation existante, vidéos, etc. Notez les choses que vous trouvez confuses ou qui vous ont pris un certain temps à comprendre. Y a-t-il des questions sur le sujet sur le forum?
2. Quels concepts sont impliqués? Doodling un petit diagramme peut aider. N'essayez pas d'être complet, mais indiquez clairement ce qui est important pour ce tutoriel et ce qui ne l'est pas.
3. Y a-t-il des connaissances ou des compétences spécifiques nécessaires pour enseigner dans votre tutoriel?
4. Créez un exemple dans lequel vous pouvez utiliser tous les concepts et compétences que vous souhaitez transmettre dans ce tutoriel. Rendez l'exemple aussi simple que possible.
5. Définissez et écrivez des étapes pour arriver à un résultat final. Chaque étape doit être reproductible par votre élève.
6. Filtrez toutes les explications, références, alternatives et cas particuliers: les mettre dans des articles séparés.
7. Écrivez une introduction. Qu'allez-vous apprendre dans ce tutoriel? Mentionnez tous les prérequis nécessaires pour faire le tutoriel.
8. Rédigez le résumé. Qu'avons-nous appris? Vous pouvez également mentionner les prochaines étapes à suivre pour en savoir plus.
9. Ajouter screenshots avec des annotations pour illustrer les actions à entreprendre. Conseil : utiliser des chiffres dans la capture d'écran et donner des explications dans le texte. Cela facilite la réutilisation de votre capture d'écran dans les traductions et minimise l'effort pour produire des captures d'écran spécifiques à la langue.
10. Ajoutez des diagrammes pour expliquer les structures, les relations et les processus.
11. Ajoutez les articles d'accompagnement avec des explications, des références et des guides pratiques.
12. Mettez tous les articles d'un sujet sous un article de synthèse, expliquant ce qui est quoi, comment ils se rapportent et par où commencer.

Exemple: Créer et publier un article dans Joomla

Par exemple, créons un tutoriel sur la façon de créer et de publier un article sous un élément de menu dans Joomla.

Collecte d'informations

Dans notre manuel d'utilisation Vous trouverez des articles pertinents sous "Commencer", "Articles" et "Menus". Il est souvent déroutant en commençant par Joomla, que vous ne voyez pas un article après en avoir créé un, même si vous l'avez marqué comme "publié". Pour voir l'article, il doit y avoir un lien vers celui-ci. Il existe plusieurs façons de créer un tel lien (comme un élément de menu ou une mise en page de blog de catégorie ou en le mettant sur la mise en page d'accueil du blog en marquant l'article comme présenté ou en établissant un lien à partir d'un autre article), mais nous allons maintenant nous concentrer sur la mise à disposition de l'article via un élément de menu.

Concepts et compétences

Nous avons 'contenu', 'article', 'menu' et 'menu-item'. Nous devons clarifier ces termes. Nous montrons où trouver ces choses dans le menu d'administration. Nous laissons de côté les «catégories» ou les «caractéristiques» dans ce tutoriel.

Conditions préalables

Vous devez avoir accès au côté administrateur d'un site Web Joomla fonctionnel et savoir comment vous connecter.

Objectif

Notre objectif est d'apprendre à créer un nouvel article Joomla et un nouvel élément de menu sous lequel nous mettons notre article.

Étapes

Suivez les étapes suivantes pour atteindre notre objectif:

A. créer un article

1. Connectez-vous à votre panneau administrateur Joomla.
2. D'abord, nous allons créer l'article. Accédez au menu "Contenu" à gauche et sélectionnez "Articles".
3. Cliquez sur "Nouveau" pour créer un nouvel article.
4. Saisissez un titre et un contenu pour votre article.
5. Cliquez sur "Enregistrer et fermer" pour enregistrer votre article.
   
   

B. Créer un élément de menu lié à l'article

afin de montrer l'article sur le site, nous allons créer un élément de menu lien vers l'article. Accédez au menu "Menus" sur la gauche et sélectionnez "Menu principal".

1. Tout comme pour un article, cliquez sur "Nouveau" pour créer un nouvel élément de menu.
2. Saisissez un titre pour votre élément de menu. C'est le titre tel qu'il apparaîtra dans le menu. Il ne doit pas nécessairement être le même que le titre de l'article. Il est généralement plus court que le titre d'un article afin de mieux s'intégrer dans le menu.
3. Sélectionnez un type d'élément de menu: sous "Articles", sélectionnez "Article unique".
4. Sélectionnez l'article: sélectionnez l'article que nous venons de faire.
5. Allez sur le site et rafraîchissez-vous. Félicitations: Vous pouvez maintenant cliquer sur l'élément de menu pour voir votre article.

Introduction

Écrivez l'introduction: ce que vous apprendrez dans ce tutoriel et quelles conditions préalables sont nécessaires.

Filtrer les informations supplémentaires

Pouvons-nous laisser de côté quoi que ce soit dans ce qui a été écrit jusqu'à présent? Eh bien, à l'étape 2 de la création d'un élément de menu, j'ai mentionné que le titre de l'élément de menu ne doit pas nécessairement être le même que le titre de l'article. Est-ce un ajout nécessaire à ce tutoriel? Si ce n'est pas le cas, nous ferions mieux de le laisser de côté pour l'instant. Mais il donne un indice pour un article plus spécialisé sur les titres d'article et les titres de menu et quand ils sont affichés, impliquant les options générales de l'article, les paramètres individuels de l'article sous l'onglet options, les paramètres menu-item sous l'onglet options du menu-item et plus encore. Il serait également bon de faire un article de référence sur la façon dont les articles, les catégories et les éléments de menu fonctionnent ensemble; Dans un tel article, essayez d'être complet, énumérez toutes les possibilités. Un article pratique spécialisé pourrait être: "Comment afficher le titre de l'article?", montrant les paramètres dans les paramètres généraux de l'article, et dans les paramètres individuels de l'article et du menu. Un article de type explications pourrait dire quelque chose sur l'arrière-plan pourquoi Joomla utilise "article" où par exemple WordPress utilise "post" ou comment l'article est rendu dans la dernière page.

Conclusion

Récapitulez tout dans un résumé. Et mentionnez éventuellement les prochaines étapes pour en savoir plus (comme: un tutoriel sur l'ajout d'une catégorie ou un guide pratique sur le raccourci sauvegarde-menu).

Images et graphiques

Faire screenshots montrant les boutons et champs impliqués dans la création d'un article et d'un élément de menu. Marquez les boutons et les champs concernés.

Pour plus de clarté, vous pouvez ajouter un diagramme montrant comment un article est placé "sous" un élément de menu.

Ajouter des références, des guides pratiques et des explications

Mettez toutes les informations et instructions supplémentaires dans des articles distincts.

Vue d'ensemble

Si vous avez plusieurs articles sur un sujet, vous devriez faire un article de synthèse, expliquant comment les articles se rapportent et par où commencer.

Exercice

Commencez à faire le tutoriel ci-dessus comment créer et publier un article dans Joomla. La meilleure façon d'apprendre est de faire. Nous publierons un exemple à quoi cela peut ressembler dans le courant manuel d'utilisation (boîte à sable) site. Mais nous serions heureux d'y mettre votre version si vous pouvez améliorer la version actuelle.