Processus de révision

Présentation du processus

1. Rôle du certificateur

Le certificateur est chargé de la révision des tutoriels intégrés à l’application. Il transmet ses commentaires à l’auteur ainsi que ceux émis dans le cadre de l’évaluation de la qualité.

2. Workflow

Lors de la révision initiale du contenu

• La vue TB Content Production View permet de suivre l’état d’avancement.
  • Le statut TB_content_status est actualisé au fil de la progression du tutoriel dans le pipeline.
  • Le titre du tutoriel est finalisé en collaboration avec le responsable de la communauté. Une fois que le certificateur et le responsable de la communauté ont convenu d’un titre définitif, le certificateur le renseigne dans Tutorial Builder via le champ final_title.
  • Le titre doit être finalisé et ajouté dans Alexandria avant l’envoi du tutoriel à l’étape d’évaluation de la qualité.
• Le certificateur approuve ou rejette le tutoriel (plusieurs cycles possibles).
  
  • Approbation : le tutoriel passe en évaluation de qualité.
  • Refus :
    • Le certificateur ajoute des commentaires dans le document Author Brief et mentionne l’auteur à l’aide d’une balise.
    • Le certificateur refuse le tutoriel dans Tutorial Builder.
    • L’auteur reçoit une notification par e-mail l’informant que son tutoriel doit être modifié comme indiqué dans son document Author Brief, disponible dans ce dossier : +Author feedback on tutorials.
  • L’auteur modifie, prévisualise et renvoie son tutoriel via Tutorial Builder.
• Le certificateur approuve le tutoriel.
• Lors de la révision dans le cadre de l’évaluation de qualité
  • La vue TB Content Production View permet de suivre l’état d’avancement.
    • Le statut TB_content_status est actualisé au fil de la progression du tutoriel dans le pipeline.
    • Si un tutoriel est refusé à l’issue de l’évaluation de qualité, celui-ci est renvoyé au certificateur dans Tutorial Builder. Les commentaires sont répertoriés dans le champ qe_comments, avec le nom du certificateur mentionné via un symbole @.
    • Si aucune correction n’est requise, le certificateur ajoute une balise @ QE dans le champ qe_comments, suivie de la date et de ses initiales, puis approuve le tutoriel et modifie son statut dans TB_content_status pour le définir sur « Curator: QE content approved ».
  • Si des corrections sont nécessaires :
    • Le certificateur ajoute des commentaires dans le document Author Brief et mentionne l’auteur à l’aide d’une balise.
    • Le certificateur refuse le tutoriel dans Tutorial Builder.
    • L’auteur reçoit une notification par e-mail l’informant que son tutoriel doit être modifié comme indiqué dans son document, disponible dans ce dossier : +Author feedback on tutorials.
    • L’auteur modifie, prévisualise et renvoie son tutoriel via Tutorial Builder.
    • Le certificateur vérifie les corrections, mentionne le cas échéant la personne en charge de l’évaluation de la qualité à l’aide d’une balise dans le champ qe_comments pour l’informer, ajoute la date et ses initiales, puis approuve le tutoriel dans Tutorial Builder.
      • Pour Illustrator : le certificateur ajoute des commentaires de révision au sujet des images et du texte de chaque section. Il ajoute des lignes distinctes pour les commentaires relatifs aux images.

3. Consignes applicables au certificateur

• Le certificateur révise ce que l’utilisateur verra.
• Il vérifie la facilité d’utilisation.
  • Il s’assure que les infobulles fonctionnent et pointent vers l’emplacement approprié.
• Il veille à ce que le tutoriel soit conforme aux bonnes pratiques, aux consignes sur les ressources et aux spécifications relatives aux images.
• Il connaît les limites actuelles de Tutorial Builder et suggère des solutions alternatives pour éviter les blocages.
• Il détermine si le contenu est présenté de manière optimale pour l’utilisateur.
  • Il tient compte du niveau des utilisateurs (débutant, intermédiaire ou expert).
• Il s’assure que chaque étape a été créée à l’aide de la méthode privilégiée.
  • Connaissant la meilleure approche pour créer une infobulle, le certificateur sait identifier les cas où un auteur n’a pas ajouté une infobulle au bon emplacement. 
• Il évalue la conformité du tutoriel aux sujets et aux objectifs d’apprentissage prévus.
  • Le cas échéant, il retravaille le tutoriel avec son auteur pour le rapprocher de son objectif.
• Il vérifie le fichier de démarrage pour s’assurer qu’il respecte a) les consignes et b) les limites actuelles des fonctionnalités de Tutorial Builder. 
• Révision :
  • Il vérifie l’absence de fautes de frappe.
  • Il vérifie l’absence de phrases interminables.
  • Il vérifie la ponctuation.
• Il permet à l’auteur de faire entendre sa voix.
• Si un certificateur rencontre un problème technique pouvant s’apparenter à un bug dans Tutorial Builder, il est invité à consulter son Community Manager. 
  • Il doit se préparer à soumettre un ticket JIRA si nécessaire.

Balisage des tutoriels publiés

1. Accédez en mode Certificateur à l’onglet Publié.
2. Sélectionnez le tutoriel dans la liste.
3. Cliquez sur les trois points, puis sélectionnez Créer une version.
   1. Une nouvelle version (2.1, par exemple) du tutoriel est créée et placée dans l’onglet En révision du certificateur.  Le tutoriel est toujours affiché dans l’onglet Publié (la version 2.0, par exemple), et l’option Créer une version est remplacée par Version en cours.
4. Accédez à l’onglet En révision du certificateur.
5. Sélectionnez le tutoriel dans la liste.
6. Cliquez sur les trois points, puis sélectionnez Attribuer à moi-même si vous vous chargez vous-même des modifications.
7. Si vous avez sélectionné Attribuer à moi-même, passez en mode Auteur.
8. En mode Auteur, accédez à l’onglet Nécessite une révision.
9. Sélectionnez le tutoriel dans la liste.
10. Cliquez sur les trois points, puis choisissez Édition.
11. Modifiez le tutoriel (ajout des balises taxonomiques).
12. Une fois l’opération terminée, cliquez sur le bouton Enregistrer.
    1. Cette étape est essentielle, car le tutoriel n’est pas automatiquement enregistré lors l’ajout de balises taxonomiques.
13. Envoi du tutoriel
    1. Le tutoriel est envoyé au certificateur.
    2. Le tutoriel est supprimé de l’onglet Nécessite une révision du certificateur-auteur.
14. Le tutoriel est désormais dans l’onglet En révision du certificateur avec le statut Prêt pour l’éditeur.
15. Passez en mode Certificateur et validez le tutoriel.
    1. Statut du tutoriel = Prêt pour QE
16. Passez en mode QE et validez le tutoriel.
    1. Statut du tutoriel = Prêt pour LOC