La documentation est l’autre moitié d’un tutoriel
Certaines personnes regardent, d’autres survolent, et les moteurs de recherche indexent les mots. Produire une vidéo et un guide écrit séparément revient à rédiger deux fois la même démonstration. Capture comprend déjà assez bien votre tutoriel pour en nettoyer la voix off : la version écrite découle donc du même travail.
Comment fonctionne Generate guide
- Montez le tutoriel comme d’habitude. Les coupes se répercutent dans le guide.
- Cliquez sur Generate guide dans l’éditeur. Si le projet n’a pas encore de transcription, Capture le transcrit d’abord.
- Capture rédige le guide à partir de la transcription, de préférence celle de votre voix off optimisée, et de vos clics : un titre, une introduction et des étapes numérotées.
- Chaque étape reçoit une capture d’écran tirée de l’enregistrement au moment où vous avez cliqué, ainsi qu’un lien vers ce moment dans la vidéo.
Si vous modifiez le montage plus tard, le guide est signalé comme obsolète. Régénérez-le pour le remettre à jour.
Comment rédiger une documentation logicielle quand vous préférez la démontrer
Demandez à n’importe quelle personne qui gère un centre d’aide ce qui ralentit la documentation : ce n’est jamais la saisie. C’est décider de l’ordre des étapes, se souvenir du prérequis que l’on saute machinalement, et décrire un écran de mémoire avec assez de précision pour qu’un inconnu puisse suivre.
Démontrer la tâche règle les trois problèmes. Vous réalisez les étapes dans le bon ordre parce que le produit vous y oblige, le prérequis apparaît parce que vous le faites réellement, et l’écran est décrit avec exactitude parce que l’enregistrement est l’écran. Ensuite, vous retravaillez un brouillon au lieu de partir d’une page blanche.
Une bonne documentation a toujours besoin d’un humain pour décider de ce qui compte. Elle n’a simplement plus besoin qu’il retranscrive ses propres clics.
Où cela s’inscrit dans Braiv Capture
Les guides sont une fonctionnalité complémentaire de Braiv Capture, qui repose sur l’optimisation de la voix off. Ils sont rédigés dans la langue source du tutoriel. Pour des guides écrits à partir de vidéos déjà publiées sur YouTube, consultez Vidéo YouTube en article de support.
