Benutzerhandbuch für Auditor: Organisation und Konventionen

Da die Benutzeroberfläche (UI) des axe Auditor-Produkts sorgfältig entwickelt wurde, um den manuellen Barrierefreiheitstestanforderungen von Spezialisten für Barrierefreiheit gerecht zu werden, ist diese Benutzerdokumentation ähnlich organisiert. Basierend auf Nutzerforschung und -bewertung, Umfragen, Nutzererzählungen und häufig durchgeführten Anwendungsszenarien, haben unsere Experten in den letzten zwei Jahren den Prozess der Barrierefreiheitstests, der Priorisierung von Problemen und der Berichtserstellung verfeinert, den wir auf den Websites unserer Kunden zur Etablierung und Verfeinerung der Deque-Methode für Barrierefreiheitstests und des zugehörigen geführten Barrierefreiheitstests-Werkzeugs, axe Auditor, anwenden. Daher werden Sie das Inhaltsverzeichnis dieses Leitfadens genauso intuitiv finden wie die Benutzeroberfläche selbst, was es umso praktischer als Begleiter bei der Nutzung der Anwendung macht.

Das Hauptmenü oben und die schnellen Seitenlinks in der Benutzeroberfläche von axe Auditor.

Das linke Seitenleisteninhaltsmenü und die schnellen Seitenlinks innerhalb der Seite in diesem Benutzerhandbuch.

Unabhängig davon, ob Sie mit einem neuen Projekt beginnen oder zu einem bereits laufenden zurückkehren, werden Sie es als vertraute Referenz intuitiv nutzen können. Wenn Sie also Tests auf neuen Builds und mehreren Browsern erneut durchführen, überprüfen, ob Anforderungen erfüllt wurden, präzise und konsistente Barrierefreiheitsberichte für Entwickler erstellen oder umfassende Berichte für das Management erstellen, wird es genauso einfach sein, die richtige „How-to“-Information für diese weniger häufig durchgeführten Aufgaben zu finden, wie dort weiterzumachen, wo Sie einen Testrun in axe Auditor selbst unterbrochen haben. Die Such-, Inhalts-, Index-, Breadcrumb- und Querverweislings sorgen dafür, dass Sie schnell das bekommen, was Sie brauchen.

• Konventionen die in diesem Dokument verwendet werden, gelten als für das beabsichtigte Publikum von Natur aus verständlich, werden jedoch auch unten kurz erklärt. Diese Dokumentation verwendet eine konsistente Stilformatierung, um das Scannen zu erleichtern. Dazu gehören:

• Struktur: Wie weiter oben auf dieser Seite erwähnt, spiegelt die Struktur dieser Dokumentationssammlung im Allgemeinen die Benutzeroberfläche wider, gelesen von links nach rechts, von oben nach unten, und versucht, Informationen dort verfügbar zu machen, wo sie benötigt werden, ohne Redundanz.

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

• Vorsicht, Hinweis, Wichtig: Warnhinweise wie solche, die erforderliche Vorbedingungen, konzeptionelle oder ergänzende Informationen zur Durchführung einer Aufgabe bereitstellen, erscheinen als Notizen auf farbigen Hintergründen, die in abgerundeten Eckenrahmen eingeschlossen sind, um Ihre Aufmerksamkeit darauf zu lenken.

• Textformatierung: Diese Dokumentationssammlung verwendet die typografische Konvention von Fett (starker Stil) als Formatierung, um „klickbare“ Benutzeroberflächenelemente wie Schaltflächen in Verfahrensanweisungen klar zu kennzeichnen oder als einleitende Phrasen, um sie einzuführen.

• Beispieleingabe: Vorgefertigte Codeschnipsel und Beispiele können hervorgehoben und/oder passend formatiert werden, um Ihnen die notwendige Einrückung und Zeilenabstände zu bieten. Typischerweise wird hierfür eine abweichende Schriftart wie Courier New.

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

Direktes Dokumentationsfeedback: Feedback des Publikums (Leser) zu dieser Dokumentationssammlung, unabhängig von Ihrer Endbenutzerrolle, gehört zu den wertvollsten Inputs, die wir erhalten und ist immer willkommen! Um jederzeit Feedback zu diesem Benutzerhandbuch (und dem Online-Hilfesystem) einzureichen, können Sie entweder das allgemeine Feedback-Formular in der Benutzeroberfläche der axe Auditor-Anwendung selbst verwenden, die allgemeinen Helpdesk-Kontaktinformationen unten, oder eine E-Mail an axe-auditor-feedback@deque.com.