Consignes de rédaction

1. Nombre de sections, d’étapes et de notes

Le tableau ci-dessous indique le nombre maximal de sections et d’étapes disponibles pour créer un tutoriel. Veillez cependant à en utiliser le moins possible ! 

Recommandations

• Sections : les tutoriels les plus efficaces comportent moins de quatre sections, mais vous pouvez en créer jusqu’à dix.
• Étapes : chaque section doit idéalement contenir trois étapes, et jamais plus de cinq. Évitez d’inclure toutes les étapes dans une seule section.
  
• Notes : une étape ne doit pas comporter plus de deux notes. 

Conseil : pour plus d’informations sur la rédaction des sections, des étapes et des notes, reportez-vous à la rubrique Création d’un tutoriel > Tutoriels.

Limitations de caractères

Dans TBW, chaque champ de texte inclut un compteur qui vous permet de respecter les limitations de caractères.

2. Titres et descriptions

Titres de tutoriel

• Optez pour un titre qui donne des indications sur le thème du tutoriel.
• Veillez à ce qu'il soit indexable et optimisé pour le référencement naturel.
• Le titre doit commencer par un verbe d’action et non par un substantif.
  • Exemple : Éclaircir une photo sombre à l’aide d’un calque de réglage
• Évitez de commencer par « Comment » ou « Apprendre à ».
• Si vous mentionnez une fonctionnalité dans le titre, indiquez à quoi elle servira.
  • Exemple : Supprimer des objets d’une photo à l’aide de l’outil Correcteur
• Le titre ne doit pas comporter plus de 120 caractères, espaces compris. Plus il est succinct, mieux c’est.
• Optez pour un titre court.

Titres de section

• Un titre de section doit commencer par un substantif et résumer ce que l’utilisateur ou l’utilisatrice va accomplir en suivant les étapes correspondantes.
  • Exemple : Perfectionnement de l’illustration
  • L’utilisation de substantifs dans les titres de section s’explique par le fait que certaines personnes considèrent ces titres comme des étapes. En passant d’un verbe à un substantif, vous avez plus de chances de répondre aux attentes.
• N’ajoutez pas de point à la fin d’un titre de section.

Descriptions de tutoriel

• La description du tutoriel apparaît sous le titre sur l’écran de démarrage. Elle vous permet de décrire le contenu du tutoriel et son utilité.
• Ajoutez un point à la fin de la description du tutoriel.
• Exemple : Réglez la luminosité et le contraste d’une photo sombre.
  

Descriptions de section

• La description d’une section apparaît sous son titre. Utilisez ce champ pour expliquer ce que l’utilisateur ou l’utilisatrice va apprendre dans cette section. La concision est de mise !
• Ajoutez un point à la fin de la description d’une section.
• Exemple : Un masque de fusion permet de masquer une partie du calque d’une image sous-jacente sans modifier définitivement le calque de l’image.

3. Éléments d’interface

Lors de la création d’étapes, vous mentionnerez sans doute un outil, un menu ou un panneau qui aidera l’utilisateur ou l’utilisatrice à effectuer la tâche. Recherchez cet élément dans le champ de texte de l’étape en utilisant le symbole @ pour trouver et insérer l’outil ou la fonctionnalité en question.

Pendant la saisie, une liste de suggestions de fonctionnalités apparaît afin que vous puissiez en choisir une. Une fois la fonctionnalité sélectionnée, son nom sera formaté différemment du reste du texte. Une infobulle dans un cadre bleu fournit une assistance visuelle permettant de trouver la fonctionnalité qui convient.

Si vous ne voyez pas la fonctionnalité que vous souhaitez utiliser, saisissez son nom sans le symbole @. Pour les commandes de panneau et de menu, précisez le workflow à l’aide du signe >. Utilisez uniquement le nom de l’élément d’interface dans le produit. Aucune infobulle n’est créée dans ce cas. 

• Exemple : Calques > Actions de calque > Verrouiller les calques

Si vous vous rendez compte que plusieurs outils et fonctionnalités ne sont pas disponibles lorsque le symbole @ est utilisé, informez-en une personne de l’équipe Learn Global Operations.

4. Terminologie

Les tableaux ci-dessous répertorient les termes clés que les auteurs et les autrices doivent connaître et utiliser.  

Acronymes

Noms d’application

Suivez ces consignes lorsque vous mentionnez le nom d’une application dans un tutoriel :

• N’incluez pas « Adobe » dans le nom de l’application, sauf mention contraire explicite dans la colonne « Utiliser ». 
• Mentionnez Photoshop uniquement lorsque cela apporte une clarification nécessaire. 
• N’incluez pas « CC » dans le nom de l’application. 
• Si vous devez utiliser un nom d’application, limitez-vous à ceux répertoriés dans la colonne « Utiliser ».

Terminologie propre aux tutoriels

Selon certaines études et la terminologie privilégiée, certaines formulations sont à utiliser ou à éviter. La liste ci-dessous les recense, en indiquant les raisons de ces préférences. Une terminologie uniforme garantit la cohérence de l’environnement d’apprentissage.

5. Ponctuation 

Utilisez une ponctuation correcte, par exemple, en insérant un point à la fin des descriptions, des étapes et des notes. Les titres ne nécessitent ni point, ni aucune autre forme de ponctuation.

6. Utilisation des majuscules

Utilisez des majuscules initiales dans votre tutoriel, notamment dans les titres, les descriptions et les étapes.