Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt

Use this file to discover all available pages before exploring further.

Cette page explique les bonnes pratiques pour utiliser des captures d’écran, des GIF et des vidéos dans votre documentation.
Les captures d’écran, les GIF et les vidéos peuvent enrichir la documentation, mais nécessitent une maintenance continue à mesure que les éléments d’interface évoluent. Utilisez-les avec parcimonie pour éviter une surcharge de maintenance inutile. Principes clés :
  • Les médias doivent être complémentaires. Si un processus est clair avec le texte seul, évitez d’ajouter des éléments visuels.
  • Veillez à l’accessibilité. Ajoutez un texte alternatif pour les images, des sous-titres pour les vidéos et des transcriptions pour le contenu audio. De nombreuses personnes utilisent des technologies d’assistance et un contenu accessible profite à tous les utilisateurs.
  • Équilibrez clarté et facilité de maintenance. Des changements fréquents de l’interface peuvent rendre rapidement obsolètes les captures d’écran et les vidéos. Demandez-vous si l’effort nécessaire pour les mettre à jour se justifie par la valeur qu’ils apportent.

​
Quand utiliser des médias

  • Captures d’écran pour les tâches difficiles à expliquer avec des mots.
  • GIF à des fins promotionnelles et pour des flux de travail courts mais complexes.
  • Vidéos pour les concepts abstraits et les longs flux de travail.
Utilisez les médias avec parcimonie et à bon escient pour éviter une dette de documentation inutile. Bien utilisés, ils améliorent la compréhension sans alourdir la maintenance ni créer de barrières à l’accessibilité.