Benutzerhandbuch für Auditor: Organisation und Konventionen

Da die Benutzeroberfläche (UI) des axe Auditor Produkts sorgfältig konzipiert wurde, um den manuellen Barrierefreiheitstestanforderungen von Spezialisten gerecht zu werden, ist auch dieses Benutzerhandbuch ähnlich organisiert. Basierend auf Nutzerforschung und -bewertung, Umfragen, Nutzerstorys und häufig durchgeführte Anwendungsszenarien haben unsere Experten in den letzten zwei Jahren den Prozess der Barrierefreiheitstests, der Priorisierung von Problemen und der Berichtserstellung, den wir für die Websites unserer Kunden nutzen, verfeinert, um den The Deque Way der Barrierefreiheitstests und das dazugehörige geführte Testtool axe Auditor zu etablieren und weiterzuentwickeln. Daher finden Sie das Inhaltsverzeichnis dieses Handbuchs genauso intuitiv wie die Benutzeroberfläche selbst, was es umso praktischer macht, als Begleiter bei der Nutzung der Anwendung.

Das obere Hauptmenü und die Schnellzugriffe in der axe Auditor-Benutzeroberfläche.

Das Inhaltsverzeichnis im linken Seitenmenü und die Schnellzugriffe innerhalb der Seite in diesem Benutzerhandbuch.

Egal, ob Sie ein neues Projekt von Grund auf beginnen oder in ein bereits laufendes zurückkehren, Sie werden es intuitiv finden, diese Dokumentation als vertraute Referenz zu verwenden. Wenn Sie also Tests auf neuen Builds und mehreren Browsern neu starten, überprüfen, ob Anforderungen erfüllt wurden, präzise und konsistente Barrierefreiheit-Mängelberichte für Entwickler erstellen oder umfassende Berichte für das Management anfertigen, wird es genauso einfach sein, die richtige „How-to“-Information für jene weniger häufig durchgeführten Aufgaben zu finden, wie dort weiterzumachen, wo Sie bei einem Testrun in axe Auditor aufgehört haben, und die Such-, Inhalts-, Index-, Breadcrumb- und Querverweis-Links helfen Ihnen schnell, das zu bekommen, was Sie brauchen.

• Konventionen , die in diesem Dokument verwendet werden, gelten als von der beabsichtigten Zielgruppe inhärent verständlich, werden jedoch im Folgenden kurz erläutert. Diese Dokumentation verwendet ein konsistentes Stilformat, um das Scannen zu erleichtern. Dazu gehören:

• Struktur: Wie bereits auf dieser Seite erwähnt, spiegelt die Struktur dieses Dokumentations-Sets im Allgemeinen die Benutzeroberfläche wider, wie Sie es von links nach rechts, von oben nach unten lesen, und versucht, Informationen dort bereitzustellen, wo sie benötigt werden, ohne Redundanz.

• Titel und Überschriften: Prozedurtitel beginnen typischerweise mit einem Gerundium in Überschriften, die klar die nachfolgende Information identifizieren.

• Achtung, Hinweis, Wichtig: Warnhinweise wie die Bereitstellung von erforderlichen Voraussetzungen, konzeptionellen oder ergänzenden Informationen, die für den Abschluss einer Aufgabe erforderlich sind, erscheinen als Notizen vor farbigen Hintergründen und sind in Rahmen mit abgerundeten Ecken eingeschlossen, um Ihre Aufmerksamkeit auf sie zu lenken.

• Textformatierung: Dieses Dokumentations-Set verwendet die typografische Konvention von fett (starker Stil) als Formatierung, um „klickbare“ Benutzeroberflächenelemente wie Schaltflächen in Verfahrensanweisungen eindeutig zu identifizieren oder als einleitende Phrasen, um sie vorzustellen.

• Beispielinput: Vorgefertigte Codebeispiele und Beispiele sind so formatiert und/oder hervorgehoben, dass sie Ihnen die notwendige Einrückung und Zeilenabstand bieten. Typischerweise wird dabei eine abweichende Schriftart verwendet wie Courier New.

• Grafische Bilder: Screenshots werden nur zu Demonstrationszwecken verwendet, spiegeln aber, wenn möglich, tatsächliche Auswahldaten und reale Beispielangaben wider. Solche Grafiken sind in der Nähe des Textes positioniert, den sie unterstützen, und mit Alt-Text versehen.

Direktes Feedback zur Dokumentation: Das Feedback des Publikums (Lesers), unabhängig von Ihrer Endnutzerrolle, zu diesem Dokumentations-Set ist eine der wertvollsten Informationen, die wir erhalten, und es ist immer willkommen! Um jederzeit Feedback zu diesem Benutzerhandbuch (und dem Online-Hilfesystem) zu übermitteln, können Sie entweder das allgemeine Feedback-Formular in der Benutzeroberfläche der axe Auditor-Anwendung verwenden, die allgemeinen Helpdesk-Kontaktinformationen unten oder eine E-Mail an axe-auditor-feedback@deque.com.