Le texte alternatif manquant est facile à ignorer dans Markdown car la source peut toujours paraître complète. La syntaxe de l'image est présente, le chemin du fichier est présent et le document peut s'afficher avec la capture d'écran visible. La partie manquante est le texte entre parenthèses.
Les rédacteurs techniques devraient comprendre cela avant de publier. Le Markdown Validator de Converty peut faire apparaître le texte alternatif manquant ainsi que d'autres avertissements de création, de sorte que le problème est visible alors que la source est encore facile à corriger.
Pourquoi le texte alternatif manquant se cache dans Markdown
La syntaxe des images Markdown ressemble à ceci :
Lorsque la description est manquante, l'image peut toujours s'afficher :
Cela rend le problème facile à manquer lors d’une analyse visuelle. La page peut sembler correcte à l'auteur, mais la source a perdu un contexte utile pour les lecteurs qui dépendent des alternatives textuelles et pour les réviseurs qui tentent de comprendre le rôle de l'image.
Vérifiez les images pendant la passe d'aperçu
Un flux de travail de documentation pratique doit inclure une étape de révision axée sur l'image :
- Collez le Markdown dans le Markdown Validator.
- Vérifiez l'aperçu rendu pour confirmer que l'image apparaît.
- Lisez la liste d'avertissements concernant le texte alternatif manquant.
- Revenez à la source et rédigez une description concise qui explique le but de l'image.
- Revérifiez le document avant de le publier ou de le valider.
C'est plus rapide que d'attendre qu'un réviseur détecte le problème dans une demande d'extraction ou une page publiée.
Un bon texte alternatif dépend du contexte
Le texte alternatif doit décrire pourquoi l'image est importante dans le document. Une capture d'écran d'un validateur CSV n'a pas besoin de décrire tous les pixels visibles. Il faudra peut-être indiquer que le validateur affiche des avertissements d'en-tête en double ou un aperçu analysé des lignes importées.
La meilleure description dépend du texte environnant. Si le paragraphe explique déjà complètement l'image, le texte alternatif peut être bref. Si l'image contient de nouvelles informations, le texte alternatif devrait aider à préserver ces informations.
Associez les vérifications alt à un contrôle qualité Markdown plus large
Le texte alternatif manquant est un problème de création parmi plusieurs. Un bon aperçu doit également vérifier la structure des titres, les liens, les tableaux et les barrières de code.
Pour un flux de travail plus large, lisez Comment détecter les problèmes de démarque avant la publication. Pour la révision en équipe, utilisez Comment les équipes produit et Docs peuvent réviser le Markdown sans perdre le formatage.
Ouvrez le Markdown Validator avant de publier Markdown lorsque des captures d'écran ou des diagrammes font partie du document.
