Aller au contenu

Documentation visuelle

Ce qu'est la documentation visuelle, la place des captures d'écran dans les flux de documentation et les erreurs courantes.

La documentation visuelle explique un produit, un processus ou un système principalement à l'aide d'images : captures d'écran annotées, schémas, courtes vidéos et séquences d'images pas à pas, accompagnés d'un texte bref. Elle montre au lecteur à quoi doit ressembler l'écran à chaque étape, au lieu de la seule décrire.

Les formes courantes incluent les guides pratiques, les supports d'intégration, les procédures opératoires standard, les notes de version, les rapports de bogue et les présentations de formation. Les captures d'écran sont l'élément le plus courant, car elles correspondent exactement à ce que voient les utilisateurs. Les schémas expliquent la structure, et les courtes vidéos ou les GIF montrent un mouvement que les images fixes ne peuvent pas rendre.

Pourquoi la documentation visuelle compte

Les lecteurs parcourent avant de lire. Une capture d'écran avec un marqueur numéroté sur le bon bouton leur confirme qu'ils sont au bon endroit et réduit les erreurs. Les guides visuels franchissent aussi mieux les barrières linguistiques qu'un long texte, et ils réduisent les questions répétées sur l'emplacement d'un réglage.

Où la documentation visuelle est utilisée

  • Centres d'aide et bases de connaissances.
  • Procédures internes des équipes support, finance et opérations.
  • Documentation pour développeurs qui montre les écrans de configuration.
  • Rapports d'assurance qualité et tickets de bogue.
  • Formation des nouveaux collaborateurs.

Captures d'écran dans les flux de documentation

  1. Capturer chaque étape, de préférence une capture par action.
  2. Recadrer ou encadrer l'image sur la zone pertinente.
  3. Ajouter des numéros d'étape, des flèches et de courtes étiquettes.
  4. Flouter les données privées.
  5. Exporter en PDF ou en images web, puis publier.

Action Capture de Temposhot (Command+3) enregistre la cible juste avant chaque clic accepté et peut titrer les étapes à partir de l'élément cliqué, avec Click "[[element-name]]" par défaut. L'éditeur Documents ajoute les Step Numbers et le cadrage, et l'export produit un PDF ou des images de pages.

Erreurs courantes

  • Des captures qui montrent tout l'écran alors qu'un seul panneau compte.
  • Des images périmées après une modification de l'interface.
  • Des tailles et des styles d'annotation incohérents d'une étape à l'autre.
  • Des données privées laissées dans les images publiées.

Vous refaites les mêmes captures encore et encore ?

Enregistrez une procédure une seule fois avec Action Capture, puis modifiez-la dans Documents. Consultez Action Capture.

Questions fréquentes

Combien de captures un guide doit-il comporter ?

Une capture par action qui modifie l'écran est une bonne valeur par défaut. Omettez les étapes qui n'ont pas besoin d'image.

Comment garder les captures à jour ?

Recapturez les étapes concernées après chaque modification de l'interface, et conservez les originaux de chaque version.

Sources

Ressources associées

Vous prenez toujours les mêmes captures d'écran ?

Temposhot capture un écran, une fenêtre ou une zone à intervalles programmés et exporte l'ensemble en PDF, en images, en ZIP ou en MP4. Les outils gratuits du navigateur ne permettent de traiter qu'une image à la fois.

Ressources associées

Termes associés

Tous les termes du glossaire