Benutzerhandbuch für Auditor: Organisation und Konventionen

Da die Benutzeroberfläche (UI) des Produkts axe Auditor sorgfältig entwickelt wurde, um den manuellen Barrierefreiheitstestanforderungen von Barrierefreiheitsspezialisten gerecht zu werden, ist dieses Benutzerhandbuch in ähnlicher Weise organisiert. Basierend auf Benutzerforschung und -bewertung, Umfragen, Nutzererlebnissen und häufig durchgeführten Anwendungsfallszenarien haben unsere Experten in den letzten zwei Jahren den Prozess der Barrierefreiheitstests, der Priorisierung von Problemen und der Berichterstellung, den wir auf den Websites unserer Kunden nutzen, verfeinert, um „The Deque Way“ der Barrierefreiheitstests und das zugehörige geführte Barrierefreiheitstest-Tool, axe Auditor, zu etablieren und zu optimieren. Daher werden Sie das Inhaltsverzeichnis dieses Handbuchs genauso intuitiv finden wie die Benutzeroberfläche selbst, was es als Begleiter zur Nutzung der Anwendung umso praktischer macht.

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

Das Inhaltsmenü in der linken Seitenleiste und die Schnellzugriffslinks innerhalb der Seite in diesem Benutzerhandbuch.

Unabhängig davon, ob Sie mit einem neuen Projekt frisch anfangen oder zu einem bereits begonnenen Projekt zurückkehren, werden Sie diese Dokumentation als vertraute Referenz intuitiv nutzen können. Wenn Sie also Tests auf neuen Builds und in mehreren Browsern erneut durchführen, prüfen, ob Anforderungen erfüllt wurden, präzise und konsistente Barrierefreiheitsmängelberichte für Entwickler erstellen oder umfassende Berichte für das Management erstellen, wird es genauso einfach sein, die richtige „How-to“-Informationen für weniger häufig durchgeführte Aufgaben zu finden, wie dort weiterzumachen, wo Sie in einem Testrun in axe Auditor selbst aufgehört haben. Die Suchfunktion, Inhalte, Index, Breadcrumb- und Querverweislinsks helfen Ihnen, schnell das zu finden, was Sie benötigen.

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

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

• Titel und Überschriften: Verfahrenstitel beginnen in der Regel mit einem Gerundium in Überschriften, die klar die nachfolgende Information identifizieren.

• Vorsicht, Hinweis, Wichtig: Warnhinweise wie solche, die Voraussetzung-, Konzept- oder Zusatzinformationen enthalten, die zur Erfüllung einer Aufgabe notwendig sind, erscheinen als Notizen gegen farbige Hintergründe, die in abgerundeten Rahmenecken eingefasst sind, um Ihre Aufmerksamkeit auf sie zu lenken.

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

• Beispielinput: Vorgefertigte Code-Snippets und Beispiele werden hervorgehoben und/oder entsprechend formatiert, um Ihnen dabei die nötige Einrückung und die Zeilenabstände bereitzustellen, wie erforderlich. Dies wird typischerweise die Verwendung einer abhebenden Schriftart beinhalten wie Courier New.

• Grafische Bilder: Screenshots werden nur zu Demonstrationszwecken verwendet, spiegeln jedoch, wenn möglich, echte Auswahldaten und reale Eingabe-Beispiele wider. Solche Grafiken sind nahe dem Text positioniert, den sie unterstützen, und sind mit Alternativtext versehen.

Direktes Feedback zur Dokumentation: Feedback des Publikums (Leser) zu diesem Dokumentationssatz ist, unabhängig von Ihrer Endnutzerrolle, eines der wertvollsten Eingaben, die wir erhalten, und ist immer willkommen! Um Feedback zu diesem Benutzerhandbuch (und dem Online-Hilfesystem) jederzeit zu geben, können Sie entweder das allgemeine Feedback-Formular innerhalb der Benutzeroberfläche der axe Auditor-Anwendung verwenden, die allgemeinen Kontaktdaten des Helpdesks unten oder eine E-Mail senden an axe-auditor-feedback@deque.com.