Contribuez aux guides étape par étape — une nouvelle façon d'apprendre TYPO3 de manière pratique

Auteurs : Mathias Bolt Lesniak
Traduit par : Célia - W-Seils

Lire l’article complet en version originale

Comment rendre rapidement productifs les nouveaux employés ? Comment savoir quelles compétences sont essentielles dès maintenant et lesquelles peuvent être enseignées plus tard ? Ces questions sont centrales, non seulement lors de l'intégration de jeunes employés dans une agence, mais aussi lorsque le Comité d'expansion communautaire enseigne aux développeurs web locaux comment créer des sites web gouvernementaux dans les pays du Sud.

Le programme d'intégration TYPO3 a été le premier résultat du comité : un programme de formation détaillé, prêt à être adapté et utilisé pour leur formation. Mais il ne définit que les prérequis et les objectifs de chaque leçon. Entre ce programme et la documentation exhaustive de TYPO3, il manque des instructions sur ce qu'il faut enseigner et comment. Les guides étape par étape résolvent ce problème, et nous pensons qu'ils peuvent aider toute personne qui apprend ou enseigne TYPO3.

Comme ils sont modulaires, chaque guide est indépendant. Mais ils peuvent également être combinés : plusieurs guides peuvent former des tutoriels ou des ateliers plus importants. Cela les rend flexibles tant pour l'apprentissage autonome que pour les programmes organisés.

Les guides étape par étape TYPO3 suivent plusieurs principes directeurs afin de garantir leur efficacité :

• Apprentissage pratique : vous apprenez plus rapidement en mettant en pratique, c'est-à-dire en suivant des étapes concrètes plutôt qu'en lisant des théories abstraites.
• Un chemin clair : pas de chemins divergents ni de détours facultatifs. Le guide vous guide à travers une seule méthode qui fonctionne de manière fiable.
• Explications minimales mais suffisantes : n'expliquez que ce qui est strictement nécessaire pour permettre à l'apprenant de progresser. Pour un contexte plus approfondi, les lecteurs sont encouragés à consulter des liens vers des documents plus détaillés/explicatifs.
• Progrès visibles et fiables : chaque étape doit produire un changement visible (que vous pouvez vérifier) et, à la fin, le résultat doit être reproductible.
• Faible investissement en temps : chaque guide doit pouvoir être suivi en moins de 30 minutes.

Les guides doivent également être cohérents avec les autres documents TYPO3. Ils restent ciblés en renvoyant vers des documents de référence ou des théories approfondis pertinents, si nécessaire, et ne cherchent pas à les reproduire.

Pour éviter toute confusion, il est utile de préciser ce que ces guides ne sont pas :

• Ils ne remplacent pas la documentation. Ils constituent un complément pratique et orienté vers l'action aux documents de référence approfondis, aux explications et aux configurations de la documentation existante de TYPO3.
• Ce ne sont pas des exemples ou des études de cas. Les exemples sont souvent utilisés dans la documentation à des fins d'illustration, mais ils sont généralement lus, et non suivis étape par étape. Les guides étape par étape exigent une action.
• Ce ne sont pas des explorations de nombreuses voies. Ils ne couvrent pas tous les scénarios, configurations ou branches optionnelles possibles. Ils se concentrent sur une seule voie qui fonctionne.

• Intégration plus rapide des nouveaux éditeurs, développeurs et intégrateurs : vous pouvez commencer à agir plutôt que d'apprendre passivement.
• Renforcement de la confiance : en accomplissant quelque chose de manière fiable, vous obtenez des résultats tangibles, ce qui facilite la compréhension.
• Réduction des frictions : moins de recherches pour trouver la théorie applicable, moins de malentendus, car chaque étape est prescriptive.
• Cohérence : lorsque plusieurs guides suivent le même style et la même structure, les utilisateurs savent à quoi s'attendre.

Contribuer à votre propre guide étape par étape est censé être facile. Le guide du contributeur contient tout ce que vous devez savoir, ainsi que de nombreux conseils utiles. De plus, les guides sont rédigés en MarkDown, de sorte que les options de mise en forme sont délibérément aussi simples que le contenu de votre guide devrait l'être.

Felicity Brand, experte en documentation, a créé deux vidéos expliquant certaines notions de base. Pour les débutants qui souhaitent contribuer uniquement via leur navigateur, il existe également un guide étape par étape expliquant comment contribuer à un guide étape par étape à l'aide de votre navigateur et de GitHub.

Si vous souhaitez rédiger ou améliorer un guide étape par étape, voici quelques conseils :

• Choisissez un seul objectif d'apprentissage. N'essayez pas de couvrir des workflows multitâches.
• Restez concis dans vos explications, ajoutez des liens vers la théorie ou les détails.
• Faites en sorte que chaque étape produise quelque chose de visuel ou de vérifiable.
• Testez le guide : suivez-le vous-même (ou demandez à quelqu'un d'autre de le suivre) du début à la fin pour vous assurer qu'il fonctionne.
• Respectez la durée recommandée : visez moins de 30 minutes. Un guide rapide à suivre sera également rapide à rédiger.

Pour vous aider à repérer les guides manquants, les liens vers des guides inexistants sont suivis et répertoriés comme des guides auxquels vous pouvez contribuer.

L'apprentissage de TYPO3 doit être pratique, accessible et efficace. Les guides étape par étape aident les utilisateurs à réaliser rapidement des tâches concrètes avec TYPO3, tout en s'appuyant sur la documentation existante pour approfondir leurs connaissances. Que vous soyez un nouvel intégrateur, un développeur explorant le travail d'extension ou simplement quelqu'un qui souhaite essayer quelque chose de concret, ces guides sont faits pour vous.

Prenez le temps d'explorer le registre des guides étape par étape. Le travail sur ces guides vient de commencer, mais avec votre aide, nous espérons que vous trouverez bientôt des étapes pratiques couvrant tout, de l'installation au développement d'extensions, le tout structuré pour vous aider à obtenir rapidement des résultats.