Organisation et conventions du guide d'utilisation de l'Auditor

Étant donné que l'interface utilisateur (IU) du produit axe Auditor a été soigneusement conçue pour répondre aux besoins de tests d'accessibilité manuels des spécialistes de l'accessibilité, cet ensemble de documentation utilisateur est organisé de la même manière. Sur la base de recherches et d'évaluations auprès des utilisateurs, d'enquêtes, de témoignages d'utilisateurs et de scénarios d'utilisation fréquemment utilisés, nos experts ont passé les deux dernières années à affiner les tests d'accessibilité, la priorisation des problèmes et le processus de création de rapports que nous utilisons sur les sites Web de nos clients pour établir et affiner la méthode Deque de test d'accessibilité et son outil de test d'accessibilité guidé associé, axe Auditor. Par conséquent, vous trouverez la table des matières de ce guide tout aussi intuitive que l'interface utilisateur elle-même, ce qui la rend d'autant plus pratique comme compagnon d'utilisation de l'application.

Le menu principal supérieur et les liens de navigation rapide dans l'interface utilisateur d'axe Auditor.

Le menu du contenu de la barre latérale gauche et les liens de navigation rapide dans la page de ce guide de l'utilisateur.

Que vous démarriez un nouveau projet ou que vous vous lanciez dans un projet existant en cours, vous trouverez intuitif d'utiliser cette documentation comme référence familière. Ainsi, si vous réexécutez des tests sur de nouvelles versions et sur plusieurs navigateurs, vérifiant que les exigences ont été respectées, créez des rapports de problèmes d'accessibilité précis et cohérents pour les développeurs ou créez des rapports complets pour la direction, trouver les bonnes informations « comment faire » pour ces tâches moins fréquemment effectuées sera aussi simple que de reprendre là où vous vous êtes arrêté dans un test exécuté dans axe Auditor lui-même, et les liens de recherche, de contenu, d'index, de fil d'Ariane et de référence croisée vous aident à obtenir rapidement ce dont vous avez besoin.

• Les conventions employées dans ce document sont considérées comme étant intrinsèquement compréhensibles pour le public visé, cependant, elles sont également brièvement expliquées ci-dessous. Cette documentation utilise un formatage de style cohérent pour faciliter sa lecture. Il s’agit notamment de :

• Structure : Comme indiqué précédemment sur cette page, la structure de cet ensemble de documentation reflète généralement l'interface utilisateur, comme vous le liriez de gauche à droite, de haut en bas, et tente de rendre les informations disponibles là où elles sont nécessaires sans redondance.

• Titres et en-têtes : les titres de procédure commencent généralement par un gérondif dans les en-têtes qui identifient clairement les informations qui suivent.

• Attention, Remarque, Important : les alertes telles que celles fournissant des informations préalables, conceptuelles ou supplémentaires nécessaires à l'achèvement d'une tâche apparaissent sous forme de notes sur des arrière-plans colorés entourés de bordures à coins arrondis pour attirer votre attention sur elles.

• Formatage du texte : cet ensemble de documentation utilise la convention typographique gras (style fort) comme formatage pour identifier clairement les éléments d'interface utilisateur « cliquables » tels que les boutons dans les instructions de procédure, ou comme phrases d'introduction pour les présenter.

• Exemple d'entrée : les extraits de code et les exemples préformatés peuvent être mis en surbrillance et/ou formatés de manière appropriée pour vous fournir l'indentation et l'espacement de ligne adéquats si nécessaire. En général, cela implique l'utilisation d'une police contrastante telle que Courier New.

• Images graphiques : Les captures d'écran sont utilisées à des fins de démonstration uniquement, mais, lorsque cela est possible, reflètent les données de sélection réelles et les exemples d'entrée réels. Ces graphiques sont positionnés à proximité du texte qu'ils prennent en charge et sont accompagnés d'un texte alternatif.

Commentaires directement sur la documentation : les commentaires du public (lecteur) sur cet ensemble de documentation, quel que soit votre rôle d’utilisateur final, font partie des contributions les plus précieuses que nous recevons et sont toujours les bienvenues ! Pour soumettre des commentaires sur ce guide d'utilisation (et sur le système d'aide en ligne) à tout moment, vous pouvez soit utiliser le formulaire de commentaires généraux dans l'interface utilisateur de l'application Axe Auditor elle-même, les coordonnées générales du service d'assistance ci-dessous, soit envoyer un e-mail à axe-auditor-feedback@deque.com.