Auditor-Benutzerhandbuch: Organisation und Konventionen

Da die Benutzeroberfläche (UI) des axe Auditor-Produkts sorgfältig entwickelt wurde, um den Anforderungen an manuelle Zugänglichkeitstests von Barrierefreiheitsexperten gerecht zu werden, ist diese Benutzerdokumentation in ähnlicher Weise organisiert. Basierend auf Benutzerforschung und -bewertung, Umfragen, Nutzererzählungen und häufig durchgeführten Anwendungsfallszenarien haben unsere Experten die letzten zwei Jahre damit verbracht, den Prozess der Barrierefreiheitstests, der Priorisierung von Problemen und der Berichtserstellung, den wir auf den Websites unserer Kunden verwenden, zu verfeinern und die Deque-Methode der Barrierefreiheitstests sowie das dazugehörige geführte Barrierefreiheitstest-Tool axe Auditor zu etablieren und zu verfeinern. Daher werden Sie das Inhaltsverzeichnis dieses Leitfadens genauso intuitiv finden wie die Benutzeroberfläche selbst, was es noch bequemer als Begleiter zur Nutzung der Anwendung macht.

Das oberste Hauptmenü und die Schnellzugriff-Links in der axe Auditor-Benutzeroberfläche.

Das Inhaltsmenü der linken Seitenleiste und die Schnellzugriff-Links innerhalb der Seite in diesem Benutzerhandbuch.

Unabhängig davon, ob Sie mit einem neuen Projekt beginnen oder in ein laufendes Projekt zurückkehren, werden Sie es intuitiv finden, diese Dokumentation als vertraute Referenz zu verwenden. Wenn Sie also Tests auf neuen Builds und mehreren Browsern erneut ausführen, überprüfen, ob Anforderungen erfüllt wurden, präzise und konsistente Barrierefreiheitsfehlerberichte für Entwickler erstellen oder umfassende Berichte für das Management 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 Testlauf in axe Auditor aufgehört haben, und die Such-, Inhalts-, Index-, Breadcrumb- und Querverweisslinks helfen Ihnen, schnell das zu bekommen, was Sie brauchen.

• Konventionen in diesem Dokument werden als für die beabsichtigte Zielgruppe von Natur aus verständlich angesehen, jedoch werden sie unten auch kurz erklärt. Diese Dokumentation verwendet konsequent Stilformatierungen, 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 verfügbar zu machen, wo sie benötigt werden, ohne Redundanz.

• Titel und Überschriften: Prozeduren-Titel beginnen typischerweise mit einem Gerundium in Überschriften, die klar die folgenden Informationen identifizieren.

• Achtung, Hinweis, Wichtig: Warnungen wie diejenigen, die eine notwendige Voraussetzung, konzeptionelle oder ergänzende Informationen für die Durchführung einer Aufgabe bereitstellen, erscheinen als Notizen auf farbigen Hintergründen, die innerhalb von Rundumrandecken eingefasst sind, um Ihre Aufmerksamkeit darauf zu lenken.

• Textformatierung: Dieses Dokumentationsset verwendet die typografische Konvention von Fett (starker Stil) als Formatierung, um "anklickbare" Benutzeroberflächenelemente wie Tasten in Verfahrensanweisungen klar zu kennzeichnen oder als einführende Phrasen, um sie einzuleiten.

• Beispieleingaben: Vorgefertigte Codeschnipsel und Beispiele werden hervorgehoben und/oder angemessen formatiert, um Ihnen die erforderliche Einrückung und Zeilenabstände zu bieten. In der Regel wird hierfür eine abhebende Schriftart wie Courier New.

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

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