Benutzerhandbuch für Auditor: Aufbau und Konventionen

Da die Benutzeroberfläche (UI) des Produkts axe Auditor sorgfältig entwickelt wurde, um den Anforderungen von Barrierefreiheitspezialisten beim manuellen Barrierefreiheitstest gerecht zu werden, ist dieses Benutzerdokumentationsset in ähnlicher Weise organisiert. Auf der Grundlage von Benutzerforschung und -bewertung, Umfragen, Benutzerberichten und häufig benötigten Anwendungsfallszenarien haben unsere Experten in den letzten zwei Jahren den Barrierefreiheitstest, die Priorisierung von Problemen und den Berichtserstellungsprozess verfeinert, den wir auf den Websites unserer Kunden verwenden, um The Deque Way des Barrierefreiheitstests und das dazugehörige geführte Barrierefreiheitstesttool axe Auditor zu etablieren und zu verfeinern. Daher werden Sie das Inhaltsverzeichnis dieses Handbuchs genauso intuitiv finden wie die Benutzeroberfläche selbst, was es umso praktischer als Ergänzung zur Anwendung macht.

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

Das Inhaltsmenü in der linken Seitenleiste und die Seiten-Schnellzugriffslinks in diesem Benutzerhandbuch.

Unabhängig davon, ob Sie ein neues Projekt beginnen oder zu einem in Bearbeitung befindlichen bestehenden zurückkehren, werden Sie es intuitiv finden, diese Dokumentation als vertraute Referenz zu verwenden. Wenn Sie also Tests auf neuen Builds und mehreren Browsern wiederholen, überprüfen, dass die Anforderungen erfüllt wurden, präzise und konsistente Berichte über Barrierefreiheitsprobleme für Entwickler oder umfassende Berichte für die Verwaltung erstellen, wird es genauso einfach sein, die richtige „How-to“-Information für seltener durchgeführte Aufgaben zu finden, wie dort weiterzumachen, wo Sie in einem Testrun in axe Auditor aufgehört haben. Die Suchfunktion, Inhalte, Index, Breadcrumb- und Querverweislings in der gesamten Dokumentation helfen Ihnen, schnell das zu bekommen, was Sie benötigen.

• Konventionen in diesem Dokument werden als für das Zielpublikum von Natur aus verständlich angesehen, werden jedoch auch kurz nachfolgend erklärt. Diese Dokumentation verwendet konsequent Formatierungsstile, um das Durchsuchen zu erleichtern. Dazu gehören:

• Struktur: Wie zuvor auf dieser Seite erwähnt, spiegelt die Struktur dieses Dokumentationssets im Allgemeinen die Benutzeroberfläche wider, wie beim Lesen von links nach rechts, von oben nach unten, und versucht, Informationen dort bereitzustellen, wo sie benötigt werden, ohne Redundanz.

• Titel und Überschriften: Prozedurtitel beginnen typischerweise mit einem Partizip in Überschriften, die klar die nachfolgenden Informationen identifizieren.

• Vorsicht, Hinweis, Wichtig: Warnmeldungen, wie diejenigen, die zu erfüllende Voraussetzungen, konzeptionelle oder ergänzende Informationen bieten, erscheinen als Notizen vor farbigem Hintergrund und sind innerhalb von abgerundeten Rahmen eingefasst, um Ihre Aufmerksamkeit darauf zu lenken.

• Textformatierung: Dieses Dokumentationsset verwendet die typografische Konvention von fett (starker Stil) als Formatierung, um deutlich „anklickbare“ Benutzeroberflächenelemente wie Schaltflächen in prozeduralen Anweisungen oder als Einleitungsphrasen zu kennzeichnen.

• Beispiel-Eingabe: Vorgefertigte Codeausschnitte und Beispiele werden gegebenenfalls hervorgehoben und/oder entsprechend formatiert, um Ihnen die erforderlichen Einrückungen und Zeilenabstände bereitzustellen. Typischerweise wird dabei eine sich abhebende Schriftart wie Courier New.

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

Direktes Feedback zur Dokumentation: Benutzerfeedback zu diesem Dokumentationsset ist, unabhängig von Ihrer Endbenutzerrolle, einer der wertvollsten Beiträge, die wir erhalten, und wird immer gerne entgegengenommen! Um jederzeit Feedback zu diesem Benutzerhandbuch (und Online-Hilfesystem) zu geben, können Sie entweder das allgemeine Feedback-Formular innerhalb der Benutzeroberfläche der axe Auditor-Anwendung nutzen, die allgemeinen Helpdesk-Kontaktinformationen unten verwenden oder eine E-Mail an axe-auditor-feedback@deque.com.