Guide Gauge Agents : la page a été trouvée, mais l’exemple correspond-il à cette version ?
Distinguez trouver une page et choisir la bonne version dans votre documentation. Définissez une lecture erronée sans exécuter d’agent ni tester de programme.
Gauge Agents distingue dans ses documents sur l’évaluation l’accès à la documentation, le choix du bon exemple et la validité du résultat. Une étude de cas du fournisseur parle aussi de comparer les modifications une par une. On peut examiner ces points séparément pour choisir une méthode d’évaluation. Cela ne garantit pas que l’outil trouvera le bon exemple et ne comprend pas le service d’analyse de marque du même site. Cet article s’en tient à du contenu éditorial statique, sans agents ni essai de systèmes en ligne.
Repérer d’abord les deux versions présentes sur la page
Imaginons la documentation maison d’un outil fictif de prévisualisation de mise en page. Le titre annonce la « nouvelle version », mais le petit exemple du haut vient de l’ancienne et son rapport n’affiche que le nombre de lignes. Plus bas, le nouvel exemple indique clairement « nombre de lignes et de paragraphes ». Le lecteur cherche le nombre de paragraphes. La fiche A dit « page de la nouvelle version trouvée » ; B dit « exemple contenant le nombre de paragraphes sélectionné ». Seul B répond à l’objectif. Sans étiquette de version, ajoutez des repères distincts même si les deux exemples sont corrects pour leur version respective. L’exemple ne comprend ni configuration, ni code, ni projet réel, ni exécution.
Si vous maintenez plusieurs pages et devez souvent distinguer une page introuvable d’un exemple mal choisi, envisagez une évaluation qui sépare les étapes. Si la même personne peut harmoniser directement les titres de version et les exemples des deux passages, commencer par relire la page est souvent plus efficace. Trouver la bonne page n’implique pas que le lecteur puisse accomplir son travail. Un cas présenté par le fournisseur ne vaut pas un essai de votre documentation.
À propos de cet article :Cet article s’appuie sur des informations publiques et sert de référence pour vous aider à choisir vos outils. Les fonctionnalités, les tarifs et les politiques associées peuvent évoluer à tout moment ; veuillez consulter les informations officielles les plus récentes.
Source originale :www.withgauge.com