Unterstützung für benutzerdefinierte Methodologie

Konfiguration einer benutzerdefinierten manuellen Testmethodologie in Axe Auditor

Zweck

Kunden, die den axe Auditor nutzen, müssen manchmal die manuelle Testmethodologie anpassen (die DequeWay). Dies kann erforderlich sein aufgrund:

• Spezieller interner Richtlinien, die zusätzliche oder weniger Prüfungen erfordern.
• Interner Richtlinien zur Verwendung bestimmter Werkzeuge bei der Durchführung von Tests.
• Entscheidungen der Unternehmenspolitik, die Attribute von Problemen ändern (Auswirkungen, Beschreibungen, Empfehlungen).

Dieses Dokument beschreibt die Anpassungen, die an der manuellen Testmethodologie im axe Auditor vorgenommen werden können, und erklärt, wie diese Änderungen an Deque zurückgemeldet werden, um für Ihre gehostete Instanz paketiert und bereitgestellt zu werden.

So funktioniert es: Rollen und Arbeitsablauf

Die Axe Auditor-Instanz Ihrer Organisation wird von Deque gehostet und verwaltet. Das bedeutet, dass Deque die Installation, die Versionsabfolge, das Packaging und die Bereitstellung der Methodologie verwaltet. Ihr Team ist nur für die Bearbeitung der Methodologie-Konfigurationsdateien verantwortlich. Sie müssen keine Versionsnummern aktualisieren, Pakete erstellen oder Installations- oder Datenbankbefehle ausführen. Deque kümmert sich um all dies in Ihrem Auftrag.

Der gesamte Prozess ist:

Hinweis zum Umfang: Dieses Dokument listet alle verfügbaren Anpassungstypen der Vollständigkeit halber auf. Die spezifischen Änderungen, die Ihr Team vornehmen wird, sollten mit dem vereinbarten Änderungsumfang übereinstimmen.

Bevor Sie beginnen

1. Sichern Sie das Original. Bevor Sie irgendetwas bearbeiten, machen Sie eine Kopie des entpackten package-Ordners. Wenn eine Bearbeitung das Bundle beschädigt, ist dies Ihre einzige saubere Möglichkeit zur Wiederherstellung.

cp -r package package_backup_original

2. Bearbeiten Sie nur die in jedem Abschnitt aufgeführten Dateien. Die Dateien sind voneinander abhängig. Eine Datei zu bearbeiten, die für eine bestimmte Änderung nicht aufgeführt ist – oder eine, die ist aufgeführt ist, zu übersehen – kann zu einem Paket führen, das erst fehlschlägt, nachdem es zurück zu Deque gesendet wurde.

3. Validieren Sie jede Datei, die Sie bearbeiten. Jede Datei ist JSON und muss nach der Bearbeitung weiterhin gültiges JSON sein (keine nachgestellten Kommas, ausgeglichene Klammern/Brackets). Validieren Sie, bevor Sie senden:

# Validate a single file
python3 -m json.tool package/dist/bundle/descriptions.json > /dev/null && echo "VALID" || echo "INVALID"

# Or validate every JSON file in the bundle at once
find package/dist -name "*.json" -print0 | while IFS= read -r -d '' f; do
  python3 -m json.tool "$f" > /dev/null 2>&1 && echo "VALID:   $f" || echo "INVALID: $f"
done

4. Sprachannahme. Diese Anweisungen gehen von Englisch (en) aus. Wenn Ihre Organisation eine Methodik in zusätzlichen Sprachen benötigt, informieren Sie Deque — Deque ermöglicht Sprachunterstützung während der Konfiguration. In diesem Fall muss jede Bearbeitung, die Sie in einer .en.json Datei vornehmen, auch in der entsprechenden Lokalisierungsdatei (z. B. das .nl.json Äquivalent) für jede zusätzliche Sprache vorgenommen werden.

Erlaubte Updates

Aktualisieren der Testmethodik für einen bestimmten Prüfpunkt

Nützlich, wenn Sie die Testanweisungen für einen bestimmten Prüfpunkt in axe Auditor ändern möchten.

Aktualisierte Dateien: package/dist/bundle/locales/checkpoints.en.json

Schritte:

1. Lokalisieren Sie den spezifischen Deque-Prüfpunkt in der JSON-Datei (z. B. 1.1.1.a).
2. Suchen Sie nach dem testing-methodology Attribut unter diesem spezifischen Prüfpunkt.
3. Nehmen Sie geeignete Aktualisierungen für jeden unter testing-methodology aufgelisteten Assettyp vor.
4. Speichern Sie die Datei an ihrem aktuellen Speicherort.

Hinweis: Der in axe Auditor sichtbare Prüfpunktname kann auch mit denselben Anweisungen geändert werden. Statt den testing-methodology Abschnitt zu aktualisieren, aktualisieren Sie das name Attribut unter dem relevanten Prüfpunkt in derselben Datei.

Aktualisieren der Auswirkung einer Regel

Sie können das Auswirkungsniveau (Blocker, Kritisch, Schwerwiegend, Moderat, Geringfügig) für jedes Problem innerhalb von axe Auditor ändern. Wenn Sie jedoch die Standard Auswirkung für eine Regel ändern müssen, folgen Sie diesen Anweisungen.

Auswirkungen in axe Auditor werden auf der Regel Ebene gespeichert, nicht auf der Ebene eines WCAG-Erfolgskriteriums oder Prüfpunktes. Eine einzelne Regel kann mehrere Deque-Prüfpunkte beeinflussen (z. B. Regel-ID alt-text-dynamic-image-inconsistent). Das Ändern der Auswirkung für die Regel ändert die Standardauswirkung für ein Problem, das durch die Verletzung dieser Regel über alle WCAG-Erfolgskriterien, die mit der Regel verbunden sind, ausgelöst wird.

Aktualisierte Dateien: package/dist/bundle/descriptions.json

Schritte:

1. Lokalisieren Sie die spezifische Deque-Regel in der JSON-Datei (z. B. alt-text-dynamic-image-inconsistent).
2. Suchen Sie nach dem impact Attribut unter dieser spezifischen Regel.
3. Aktualisieren Sie die Auswirkung mit einem numerischen Wert (siehe Tabelle unten).
4. Speichern Sie die Datei an ihrem aktuellen Speicherort.

Auswirkungswert-Zuordnungen

Hinzufügen eines neuen Barrierefreiheitsstandards (z. B. eines organisationsspezifischen Standards)

Wenn Sie organisationsspezifische Teststandards haben, die Sie Ihren Teams zusätzlich zu den bestehenden Standards (wie WCAG 2.1 AA oder ACAA) bereitstellen möchten, verwenden Sie die folgenden Schritte.

⚠️ Deque intern — vor der Veröffentlichung lösen: Die Dateiliste für diesen Abschnitt verweist auf drei pfadbezogene Prüfpunkte, die nicht mit dem Rest des Dokuments übereinstimmen (das dist/bundle/… verwendet): package/dist/checkpoints.json, package/dist/issue-descriptions.json und package/dist/bundle/checkpoints.json. Bestätigen Sie, ob dist/checkpoints.json und dist/issue-descriptions.json wirklich unterschiedliche kompilierte Dateien sind oder ob diese Pfadfehler sind, dann aktualisieren Sie die Liste entsprechend und entfernen Sie diese Notiz.

Aktualisierte Dateien:

• package/dist/bundle/standards.json
• package/dist/bundle/descriptions.json
• package/dist/bundle/testingMethodologies.json
• package/dist/bundle/locales/standards.en.json
• package/dist/checkpoints.json
• package/dist/issue-descriptions.json
• package/dist/bundle/checkpoints.json

Schritte:

1. Erstellen Sie ein neues Array-Objekt für den Standard in standards.json. Der einfachste Ansatz ist, das gesamte Objekt aus wcag21aa zu kopieren und es am Ende der Datei hinzuzufügen.
2. Ändern Sie id des neu kopierten Objekts in etwas Einzigartiges, das den Standard, den es repräsentiert, kennzeichnet.
3. Aktualisieren Sie das rubric-Array für das neue Objekt, um alle zugrunde liegenden Teststandards darzustellen, die Teil dieses neuen Standards sind.
4. Fügen Sie in descriptions.json für alle Regeln, die mit Ihrem neuen Standard verbunden sind, die ID des neuen Standards (aus standards.json) zum standards-Array hinzu.
5. Fügen Sie in testingMethodologies.json die ID des neuen Standards im standards-Array für jeden digitalen Asset-Typ hinzu, auf den dieser Standard zutrifft.
6. Fügen Sie in standards.en.json ein neues Objekt mit der ID und dem Namen des neuen Standards hinzu. Das name-Feld ist das, was Benutzer in der Benutzeroberfläche des axe Auditors sehen.
7. Aktualisieren Sie in dist/checkpoints.json das standards-Array unter jeder Problem-Beschreibung für die entsprechenden Kontrollpunkte.
8. Aktualisieren Sie in issue-descriptions.json das standards-Array für alle zutreffenden Regelobjekte.
9. Aktualisieren Sie in dist/bundle/checkpoints.json das standards-Array für jeden zutreffenden Kontrollpunkt mit dem korrekten Standard.

Aktualisieren Sie die kurzen und langen Problem-Beschreibungen für spezifische Regeln

Verwenden Sie diese Anweisungen, um den Kurzauswahltext der Problem-Beschreibung (kurz) und die lange Beschreibung des Problemtyps für jede Regel zu aktualisieren. Eine einzelne Regel kann mehrere WCAG-Erfolgskriterien beeinflussen — eine Änderung dieses Textes wirkt sich auf alle Erfolgskriterien aus, mit denen sie verbunden ist.

Aktualisierte Dateien: package/dist/bundle/locales/descriptions.en.json

Schritte:

1. Suchen Sie in descriptions.en.json die spezifische Regel (z.B. alt-text-dynamic-image-inconsistent).
2. Aktualisieren Sie den Text für shortText (Kurze Problembeschreibung) und issueDescText (Lange Problembeschreibung) wie erforderlich.
3. Speichern Sie die Datei in ihrem aktuellen Speicherort.

Aktualisieren Sie die Maßnahmenempfehlung

Wenn Sie die Maßnahmenbibliothek und die zugehörigen Beschreibungen an Ihre Richtlinie anpassen möchten, verwenden Sie die folgenden Anweisungen.

Aktualisierte Dateien: package/dist/bundle/locales/recommendations.en.json

Schritte:

1. Suchen Sie in recommendations.en.json die spezifische Regel (z.B. alt-text-dynamic-image-inconsistent) und die Kontrollpunkt-Kombination, für die Sie die Maßnahmenbibliothek ändern möchten.
2. Aktualisieren Sie den Text für recommendationType (Empfehlungstechnik), rule, howtofix und background (Abschnitte der Empfehlung zur Behebung) wie erforderlich.
3. Speichern Sie die Datei in ihrem aktuellen Speicherort.

Entfernen Sie digitale Asset-Typen

Verwenden Sie dies, wenn ein bestimmter Asset-Typ für Ihre Organisation nicht zutrifft (zum Beispiel, wenn PDF- oder Android-Tests nicht im Umfang enthalten sind).

Zu aktualisierende Dateien:

• dist/bundle/testingMethodologies.json — Haupt-Testmethodologie-Daten
• dist/bundle/locales/testingMethodologies.en.json — Englische Übersetzungen

Schritt 1: Entfernen Sie aus der Datei der Testmethodologien

Datei: dist/bundle/testingMethodologies.json

Finden und entfernen Sie das gesamte Objekt für die Methodologie, die Sie löschen möchten.

// BEFORE — remove this entire object (example: "native-mobile-android"):
{
  "id": "native-mobile-android",
  "techniques": ["general"],
  "standards": [
    "wcag2a", "wcag21a", "wcag22a",
    "wcag2aa", "wcag21aa", "wcag22aa",
    "acaa", "en301549-wad",
    "508-2017-wcag2", "508-2017-wcag21"
  ]
}
// AFTER — object completely removed

Schritt 2: Entfernen Sie aus der englischen Locale-Datei

Datei: dist/bundle/locales/testingMethodologies.en.json

Entfernen Sie das gleiche Methodologie-Objekt aus dieser Datei.

Fügen Sie einen neuen digitalen Asset-Typ hinzu

Verwenden Sie dies, um einen neuen digitalen Asset-Typ hinzuzufügen — zum Beispiel eine web-app- oder macos-Methodologie. Das folgende Beispiel verwendet web-app; ersetzen Sie diese durch Ihre eigene Asset-Typ-ID nach Bedarf.

Zu aktualisierende Dateien:

• dist/bundle/testingMethodologies.json — Haupt-Testmethodologie-Daten
• dist/bundle/locales/testingMethodologies.en.json — Englische Übersetzungen
• dist/bundle/locales/checkpoints.en.json — Englische Kontrollpunkt-Inhalte mit Testmethodologie-Sektionen
• dist/bundle/checkpoints.json — Haupt-Kontrollpunkt-Daten
• dist/bundle/descriptions.json — Problem-Beschreibungen mit Testmethodologie-Referenzen
• dist/bundle/schemata.json — Schema-Definitionen mit Testmethodologie-Referenzen

Schritt 1: Fügen Sie zur Datei der Testmethodologien hinzu

Datei: dist/bundle/testingMethodologies.json

Fügen Sie das neue Methodologie-Objekt dem Array hinzu.

{
  "id": "web-app",
  "techniques": ["general", "html", "aria", "css"],
  "standards": [
    "wcag2a", "wcag21a", "wcag22a",
    "wcag2aa", "wcag21aa", "wcag22aa",
    "acaa", "en301549-wad",
    "508-2017-wcag2", "508-2017-wcag21"
  ]
}

Schritt 2: Fügen Sie zur englischen Locale-Datei hinzu

Datei: dist/bundle/locales/testingMethodologies.en.json

Fügen Sie dasselbe Methodik-Objekt zu dieser Datei hinzu.

Schritt 3: Referenzen zur Checkpoint-Datei hinzufügen

Datei: dist/bundle/checkpoints.json

For each checkpoint that should support the new methodology, add it to that checkpoint's testingMethodologies array.

{
  "id": "1.4.3.a",
  "testingMethodologies": [
    "desktop", "mobile", "kiosk",
    "native-mobile-ios", "native-mobile-android",
    "pdf",
    "web-app",          // ← Add this line
    "ms-excel", "ms-powerpoint", "ms-word", "windows-desktop"
  ]
}

Schritt 4: Inhalte zur Testmethodik in die Checkpoint-Lokaldatei hinzufügen

Datei: dist/bundle/locales/checkpoints.en.json

Für jeden Checkpoint, der die neue Methodik unterstützen soll, fügen Sie die Inhalte der Testmethodik hinzu.

{
  "1.4.3.a": {
    "name": "Color Contrast (Minimum)",
    "testing-methodology": {
      "desktop": "<ol>...</ol>",
      "mobile": "<ol>...</ol>",
      "native-mobile-android": "<ol>...</ol>",
      "web-app": "<ol>\n<li>Open the web application in a modern browser</li>\n<li>Use browser developer tools to inspect text elements</li>\n<li>Check color contrast ratios using accessibility tools</li>\n<li>Verify contrast meets WCAG requirements</li>\n</ol>",  // ← Add this new entry
      "pdf": "<ol>...</ol>"
    }
  }
}

Schritt 5: Referenzen zur Beschreibungsdatei hinzufügen

Datei: dist/bundle/descriptions.json

Fügen Sie für Problembeschreibungen, die die neue Methodik unterstützen sollen, diese zum Array ihrer testingMethodologies hinzu.

{
  "id": "some-issue-id",
  "data": [
    {
      "type": "issue",
      "testingMethodologies": [
        "desktop", "mobile",
        "native-mobile-android", "pdf",
        "web-app"        // ← Add this line
      ]
    }
  ]
}

Schritt 6: Referenzen zur Schema-Datei hinzufügen

Datei: dist/bundle/schemata.json

Fügen Sie die neue Testmethodik zu den Schemadefinitionen hinzu.

{
  "testingMethodologies": {
    "desktop": null,
    "kiosk": null,
    "mobile": null,
    "native-mobile-ios": null,
    "native-mobile-android": null,
    "pdf": null,
    "web-app": null,   // ← Add this line
    "ms-excel": null,
    "ms-powerpoint": null,
    "ms-word": null,
    "windows-desktop": null
  }
}

Einen neuen Checkpoint hinzufügen

Hinzufügen eines Nicht-WCAG-Checkpoints

Wichtig: Nicht-WCAG-Checkpoints unterstützen nicht keine vordefinierten Beschreibungen oder Empfehlungen durch descriptions.json und recommendations.json. Wenn Sie Probleme mit diesen Checkpoints protokollieren, geben Sie die Beschreibungen und Empfehlungen manuell über die Erstellen Sie Ihre eigene Beschreibung-Funktion im Tool ein.

Zu aktualisierende Dateien — nur 2:

• package/dist/bundle/checkpoints.json — definiert den Checkpoint
• package/dist/bundle/locales/checkpoints.en.json — bietet lokalisierte Testmethodik

Schritt 1: Fügen Sie den Checkpoint zu checkpoints.json hinzu

{
  "id": "custom.1.1",
  "requiredSenses": {
    "sight": true,
    "hearing": false
  },
  "successCriteria": "",
  "automatedRules": [],
  "testingMethodologies": ["desktop", "mobile"],
  "grouping": "custom.1",
  "categories": [],
  "standards": ["custom"]
}

Wesentliche Felder:

• id — eindeutiger Bezeichner mit Ihrem benutzerdefinierten Format (z. B. custom.1.1, brand.2.3, TT.01.A, s.1.1).
• successCriteria — Leerzeichen string "" für Nicht-WCAG-Checkpoints (oder ein benutzerdefiniertes Format wie "tt-01.A").
• standards — Ihr benutzerdefinierter Standardbezeichner, z. B. ["custom"], ["TT508"], ["smoke"], ["brand"] (nicht ["wcag2a"]).
• testingMethodologies — Plattformen, auf denen dieser Checkpoint gilt: desktop, mobile, kiosk, native-mobile-ios, native-mobile-android, pdf, windows-desktop, ms-excel, ms-powerpoint, ms-word.
• requiredSenses — welche Sinne notwendig sind, um diesen Checkpoint zu testen (sight, hearing: true/false).
• automatedRules — optionale Liste von automatisierten Regel-Ids (typischerweise leer [] für benutzerdefinierte Checkpoints).
• grouping — logische Gruppierung zur Organisation (z. B. "custom.1", "1", "s.1").
• categories — relevante Zugänglichkeitskategorien (kann leer sein [] für Nicht-WCAG).
• terms — optionale Liste von Glossarbegriffen mit id und ordinal Eigenschaften.

Schritt 2: Lokalisierte Inhalte zu checkpoints.en.json hinzufügen

Verwenden Sie das mit Bindestrichen Id-Format: Konvertieren Sie Punkte in Bindestriche (z. B. custom-1-1, nicht custom.1.1).

"custom-1-1": {
  "examples": "<ul>\n  <li>Example 1: Describe a scenario where this applies</li>\n  <li>Example 2: Describe another scenario</li>\n</ul>",
  "related-techniques": {
    "general": "<ul>\n  <li>Technique reference 1</li>\n  <li>Technique reference 2</li>\n</ul>",
    "html": "<ul>\n  <li>HTML-specific technique</li>\n</ul>"
  },
  "testing-methodology": {
    "desktop": "<ol>\n  <li>Step 1 for desktop testing</li>\n  <li>Step 2 for desktop testing</li>\n</ol>",
    "mobile": "<ol>\n  <li>Step 1 for mobile testing</li>\n  <li>Step 2 for mobile testing</li>\n</ol>"
  },
  "name": "Your Custom Checkpoint Name",
  "overview": {
    "general": "General description of what this checkpoint tests and why it matters for accessibility.",
    "html": "HTML-specific description if applicable; otherwise can match general."
  }
}

Verwenden Sie \n für Zeilenumbrüche und geeignete HTML-Tags für Listen.

Hinzufügen eines WCAG-Checkpoints

Zu aktualisierende Dateien — 6 Dateien für eine vollständige WCAG-Checkpoint-Implementierung:

1. package/dist/bundle/checkpoints.json — definieren Sie den Checkpoint mit WCAG-spezifischen Feldern.
2. package/dist/bundle/locales/checkpoints.en.json — lokalisierte Testmethodik, Beispiele, verwandte Techniken (verwenden Sie das Bindestrichformat: 1-4-3-a, nicht 1.4.3.a).
3. package/dist/bundle/descriptions.json — Problembeschreibungen mit Auswirkungsstufen und Checkpoint-Referenzen.
4. package/dist/bundle/locales/descriptions.en.json — lokalisierte Problembeschreibungen.
5. package/dist/bundle/recommendations.json — Abhilfemaßnahmen, die mit Problembeschreibungen verknüpft sind.
6. package/dist/bundle/locales/recommendations.en.json — lokalisierte Empfehlungen (Titel, Beschreibung, Schritte, Ressourcen).

Optional — manuelle Eingabe: Wenn Sie es bevorzugen, vordefinierte Beschreibungen und Empfehlungen in den JSON-Dateien zu überspringen, können Sie diese beim Protokollieren von Problemen im Tool hinzufügen: Wählen Sie Ihren WCAG-Checkpoint, wählen Sie Erstellen Sie Ihre eigene Beschreibung anstelle eines vordefinierten aus und geben Sie dann manuell die Beschreibung und (falls erforderlich) die Empfehlung ein, die auf das gefundene Problem zugeschnitten ist.

Schritt 1: Definieren Sie den Checkpoint

Datei: package/dist/bundle/checkpoints.json

{
  "id": "1.4.3.a",
  "requiredSenses": {
    "sight": true,
    "hearing": false
  },
  "successCriteria": "1.4.3",
  "automatedRules": ["color-contrast"],
  "testingMethodologies": [
    "desktop", "mobile", "kiosk",
    "native-mobile-ios", "native-mobile-android",
    "pdf", "ms-excel", "ms-powerpoint", "ms-word", "windows-desktop"
  ],
  "grouping": "1.4",
  "categories": ["cat.distinguishable"],
  "standards": ["wcag2aa"]
}

Wichtige Felder:

• id — WCAG-Nummerierungsmuster (z. B. "1.4.3.a", "2.1.1.b").
• successCriteria — WCAG Erfolgskriterien-Nummer (z. B. "1.4.3").
• standards — "wcag2a" (Level A), "wcag2aa" (Level AA) oder "wcag2aaa" (Level AAA).
• automatedRules — Array von automatisierten Regel-IDs.
• grouping — WCAG-Richtliniennummer (z. B. "1.4", "2.1").

Schritt 2: Fügen Sie die Testmethodik hinzu

Datei: package/dist/bundle/locales/checkpoints.en.json — Verwenden Sie das Bindestrichformat (1-4-3-a).

"1-4-3-a": {
  "name": "Color Contrast (Minimum)",
  "overview": {
    "general": "Text and images of text have a contrast ratio of at least 4.5:1, except for large text which has a contrast ratio of at least 3:1.",
    "html": "Text and images of text have a contrast ratio of at least 4.5:1, except for large text which has a contrast ratio of at least 3:1."
  },
  "examples": "<ul>\n  <li>Gray text on white background with insufficient contrast</li>\n  <li>Blue text on blue background that doesn't meet requirements</li>\n</ul>",
  "testing-methodology": {
    "desktop": "<ol>\n  <li>Identify all text content on the page</li>\n  <li>Use a color contrast analyzer tool</li>\n  <li>Ensure normal text has at least 4.5:1 contrast ratio</li>\n  <li>Ensure large text has at least 3:1 contrast ratio</li>\n</ol>",
    "mobile": "<ol>\n  <li>Test on a mobile device under various lighting conditions</li>\n  <li>Use mobile accessibility testing tools</li>\n  <li>Verify contrast ratios meet WCAG requirements</li>\n</ol>",
    "assistive-technology": "<p><strong>Screen reader testing is optional for this checkpoint.</strong></p>\n<p><strong>Using NVDA:</strong></p>\n<ol>\n  <li>Navigate through text content</li>\n  <li>Verify text readability</li>\n</ol>"
  },
  "related-techniques": {
    "general": "<ul>\n  <li><a href=\"https://www.w3.org/WAI/WCAG22/Techniques/general/G18\">G18: Ensuring contrast ratio of at least 4.5:1</a></li>\n</ul>",
    "html": "<ul>\n  <li><a href=\"https://www.w3.org/WAI/WCAG22/Techniques/css/C21\">C21: Specifying line spacing in CSS</a></li>\n</ul>"
  }
}

Schritt 3: Fügen Sie Problembeschreibungen hinzu

Datei: package/dist/bundle/descriptions.json

{
  "id": "insufficient-color-contrast",
  "data": [
    {
      "type": "issue",
      "impact": 4,
      "checkpoint": "1.4.3.a",
      "standards": ["wcag2aa"],
      "references": [
        {
          "standards": ["wcag2aa"],
          "checkpoint": "1.4.3.a"
        }
      ],
      "testingMethodologies": ["desktop", "mobile"]
    }
  ]
}

Schritt 4: Fügen Sie lokalisierte Problembeschreibungen hinzu

Datei: package/dist/bundle/locales/descriptions.en.json

Fügen Sie ein Objekt für die neue Beschreibung hinzu:

"insufficient-color-contrast": {
  "shortText": "Insufficient color contrast",
  "issueDescText": "Text does not have sufficient contrast against its background to meet WCAG 2.1 AA requirements."
}

Schritt 5: Fügen Sie Empfehlungen hinzu

Datei: package/dist/bundle/recommendations.json

Verwenden Sie das Bindestrichformat (1-4-3-a) und hängen Sie es an die Empfehlungs-ID an.

{
  "id": "insufficient-color-contrast-fix-1-4-3-a",
  "data": [
    {
      "type": "recommendation",
      "description": "insufficient-color-contrast"
    }
  ]
}

Schritt 6: Fügen Sie Empfehlungstext hinzu

Datei: package/dist/bundle/locales/recommendations.en.json

"insufficient-color-contrast-fix-1-4-3-a": {
  "title": "Improve Color Contrast",
  "description": "Increase the contrast ratio between text and background colors to meet WCAG 2.1 AA requirements.",
  "steps": [
    "Use a color contrast analyzer to identify insufficient contrast",
    "Adjust text color, background color, or both to achieve a minimum 4.5:1 ratio",
    "For large text (18pt+ or 14pt+ bold), ensure a minimum 3:1 ratio",
    "Test the changes across different devices and lighting conditions"
  ],
  "resources": [
    "WebAIM Color Contrast Checker",
    "W3C Color Contrast Analyzer",
    "Chrome DevTools Accessibility Panel"
  ]
}

Einen bestimmten Checkpoint entfernen

Verwenden Sie diese Anweisungen, wenn es einen bestimmten Checkpoint gibt, gegen den Ihr Team nicht testen und berichten soll.

Aktualisierte Dateien:

• package/dist/bundle/checkpoints.json
• package/dist/bundle/descriptions.json
• package/dist/bundle/recommendations.json
• package/dist/bundle/locales/checkpoints.en.json
• package/dist/bundle/locales/recommendations.en.json

Schritte:

1. In checkpoints.json suchen Sie nach dem spezifischen Checkpoint (z. B. 1.2.1.b). Löschen Sie das gesamte Objekt, das mit diesem Checkpoint verbunden ist, und halten Sie dabei gültiges JSON aufrecht. Speichern Sie die Datei.
2. In descriptions.json suchen Sie nach dem spezifischen Checkpoint (z. B. 1.2.1.b). Löschen Sie nur das Objekt, das den Checkpoint unter der Regel verwendet, und halten Sie dabei gültiges JSON aufrecht. Eine einzelne Regel kann auf mehrere Checkpoints angewendet werden — Entfernen Sie nur das Objekt für den Checkpoint, den Sie entfernen; entfernen Sie nicht die vollständige Regel. Speichern Sie die Datei.
3. In recommendations.json suchen Sie nach dem spezifischen Checkpoint (z. B. 1.2.1.b). Löschen Sie jedes mit diesem Checkpoint verbundene Objekt (es kann mehr als eines geben), während Sie gültiges JSON aufrecht halten. Speichern Sie die Datei.
4. In checkpoints.en.json suchen Sie nach dem spezifischen Checkpoint im Bindestrichformat (z. B. 1-2-1-b). Löschen Sie das gesamte Objekt, während Sie gültiges JSON aufrecht halten. Speichern Sie die Datei.
5. In recommendations.en.json suchen Sie nach dem spezifischen Checkpoint im Bindestrichformat (z. B. 1-2-1-b). Löschen Sie jedes mit diesem Checkpoint verbundene Objekt (es kann mehr als eines geben), während Sie gültiges JSON aufrecht halten. Speichern Sie die Datei.

Änderungen an Deque zurücksenden

Wenn die Bearbeitungen abgeschlossen und validiert sind:

1. Bestätigen Sie, dass jede bearbeitete Datei immer noch die JSON-Validierung besteht (siehe Bevor Sie beginnen).
2. Bestätigen Sie, dass die Änderungen dem vereinbarten Umfang entsprechen.
3. Senden Sie den gesamten package-Ordner in seiner ursprünglichen Struktur an Deque zurück (senden Sie nicht nur einzelne Dateien).

Deque wird die Version zuweisen, das Paket zusammenstellen, es der richtigen axe-core-Version zuordnen und es in einer Testinstanz zur Überprüfung bereitstellen. Nachdem Ihr Team die Änderungen auf der Testinstanz überprüft und freigegeben hat, wird die Methodik auf Ihre Produktion-Instanz übertragen.

Unterstützung

Bei Fragen zu diesem Prozess, dem vereinbarten Änderungsumfang oder um zusätzliche Unterstützung in anderen Sprachen anzufordern, wenden Sie sich an Ihren Deque-Ansprechpartner.