Auditor-Benutzerhandbuch – Organisation und Konventionen
Da die Benutzeroberfläche (UI) des Produkts axe Auditor sorgfältig entwickelt wurde, um den Anforderungen von Barrierefreiheitsspezialisten an manuelle Barrierefreiheitstests gerecht zu werden, ist dieser Benutzerdokumentationssatz weitgehend auf die gleiche Weise organisiert. Auf der Grundlage von Benutzerforschung und -bewertung, Umfragen, Benutzergeschichten und häufig durchgeführten Anwendungsszenarien haben unsere Experten die letzten zwei Jahre damit verbracht, die Prozesse für Barrierefreiheitstests, Problempriorisierung und Berichterstellung, die wir auf den Websites unserer Kunden verwenden, zu verfeinern, um die Deque-Methode für Barrierefreiheitstests und das zugehörige geführte Barrierefreiheitstesttool axe Auditor zu etablieren und zu verfeinern. Daher ist das Inhaltsverzeichnis dieses Handbuchs ebenso intuitiv wie die Benutzeroberfläche selbst, was es zu einem noch bequemeren Begleiter bei der Verwendung der Anwendung macht.
Das obere Hauptmenü und die Schnellseitenlinks in der axe Auditor-Benutzeroberfläche.
Das Inhaltsmenü der linken Seitenleiste und die Schnellseitenlinks innerhalb der Seite in diesem Benutzerhandbuch.
Unabhängig davon, ob Sie gerade mit einem neuen Projekt beginnen oder in ein bereits laufendes Projekt einsteigen, werden Sie diese Dokumentation intuitiv als vertrautes Nachschlagewerk verwenden können. Wenn Sie also Tests auf neuen Builds und mehreren Browsern erneut ausführen, die Erfüllung der Anforderungen prüfen, präzise und einheitliche Berichte zu Barrierefreiheitsproblemen für Entwickler oder umfassende Berichte für das Management erstellen, ist das Auffinden der richtigen Anleitungen für diese weniger häufig ausgeführten Aufgaben genauso einfach, wie das Weitermachen dort, wo Sie bei einem Testlauf in axe Auditor selbst aufgehört haben. Und die Such-, Inhalts-, Index-, Breadcrumb- und Querverweislinks helfen Ihnen dabei, schnell das zu finden, was Sie benötigen.
-
Die in diesem Dokument verwendeten Konventionen gelten als für die Zielgruppe grundsätzlich verständlich, werden im Folgenden jedoch dennoch kurz erläutert. In dieser Dokumentation wird eine einheitliche Stilformatierung verwendet, um das Überfliegen zu erleichtern. Dazu gehören:
-
Struktur: Wie bereits zuvor auf dieser Seite erwähnt, spiegelt die Struktur dieses Dokumentationssatzes im Allgemeinen die Benutzeroberfläche wider, da Sie von links nach rechts und von oben nach unten lesen würden, und versucht, Informationen ohne Redundanz dort verfügbar zu machen, wo sie benötigt werden.
-
Titel und Überschriften: Prozedurtitel beginnen in der Regel mit einem Gerundium in Überschriften, das die folgenden Informationen eindeutig identifiziert.
-
Achtung, Hinweis, Wichtig: Warnungen, beispielsweise solche, die Voraussetzungen, konzeptionelle oder ergänzende Informationen bereitstellen, die für die Erledigung einer Aufgabe erforderlich sind, werden als Notizen auf farbigem Hintergrund mit abgerundeten Ecken angezeigt, um Ihre Aufmerksamkeit darauf zu lenken.
-
Textformatierung: Dieser Dokumentationssatz verwendet die typografische Konvention Fettdruck (starker Stil) als Formatierung, um „anklickbare“ Benutzeroberflächenelemente wie Schaltflächen in Verfahrensanweisungen oder als Einführungssätze zu deren Einführung deutlich zu kennzeichnen.
-
Beispiel-Eingabe: Vorformatierte Codeausschnitte und Beispiele können entsprechend hervorgehoben und/oder formatiert werden, um Ihnen bei Bedarf die entsprechende Einrückung und den erforderlichen Zeilenabstand zu bieten. Normalerweise wird hierfür eine Offsetschriftart wie
Courier New
verwendet. -
Grafische Bilder: Screenshots dienen nur zu Demonstrationszwecken, spiegeln aber, wenn möglich, tatsächliche Auswahldaten und echte Eingabebeispiele wider. Solche Grafiken werden in der Nähe des Textes positioniert, den sie unterstützen, und mit Alternativtext versehen.
Direktes Feedback zur Dokumentation: Das Feedback des Publikums (der Leser) zu diesem Dokumentationssatz gehört, unabhängig von Ihrer Endbenutzerrolle, zu den wertvollsten Eingaben, die wir erhalten, und ist immer willkommen! Um jederzeit Feedback zu diesem Benutzerhandbuch (und zum Online-Hilfesystem) abzugeben, können Sie entweder das allgemeine Feedback-Formular in der Benutzeroberfläche der axe Auditor-Anwendung selbst verwenden, die allgemeinen Helpdesk-Kontaktinformationen unten verwenden oder eine E-Mail an axe-auditor-feedback@deque.com senden.