Jira-Integrationsvorlagen

Vorlagen sind voreingestellte Zuordnungen von axe-Problemfeldern zu Jira-Feldern, die helfen, standardisierte Formate für Jira-Tickets zu erstellen. Vorlagen können für jedes Projekt und jede Kombination von Problemtypen erstellt werden und können von jedem in Ihrer Organisation verwendet werden, wenn Probleme an Jira gesendet werden.

Vorlagen-Zugriffsverwaltung

Wer kann Vorlagen erstellen

Jeder mit Zugriff auf die Jira-Integration kann Vorlagen erstellen.

Wer kann Vorlagen bearbeiten oder löschen

• Vorlagenautoren: Benutzer, die die Vorlage erstellt haben, können ihre eigenen Vorlagen bearbeiten oder löschen
• axe-Account-Portal-Administratoren: Können jede Vorlage in der Organisation bearbeiten oder löschen

Vorlagen-Berechtigungen

• Vorlagen sind organisationsweite Ressourcen
• Alle Benutzer mit Zugriff auf die Jira-Integration können jede Vorlage verwenden
• Nur Vorlagenautoren und Administratoren können Vorlagen ändern
• Vorlagen können nicht auf bestimmte Benutzer oder Gruppen beschränkt werden

Erstellen einer Vorlage

1. Navigieren Sie zur Seite „KONFIGURATION“ innerhalb des axe-Account-Portals (oder navigieren Sie direkt zu https://axe.deque.com/configuration/integrations und überspringen Sie Schritt 2)
2. Klicken Sie auf den Link „Integrationen“ innerhalb der Navigation „Konfiguration“
3. Klicken Sie auf den Link „Jira-Vorlagen konfigurieren“
4. Klicken Sie auf die Schaltfläche „Vorlage hinzufügen“
5. Füllen Sie die Felder in den Schritten „Vorlageninformationen“, „Feldzuordnung“ und „Auswirkungszuordnung“ aus. Sie können in den folgenden Abschnitten mehr Details zu jedem Schritt einsehen.
6. Überprüfen Sie die in den Schritten 1 bis 3 ausgefüllten Informationen
7. Klicken Sie auf „Speichern“

Um eine Vorlage zu verwenden, beziehen Sie sich auf den Abschnitt Senden von Problemen an Jira.

Hinzufügen von Vorlageninformationen

Der erste Schritt beim Erstellen einer Vorlage besteht darin, die grundlegenden Informationen zu konfigurieren, die bestimmen, wo und wie Probleme in Jira erstellt werden.

1. Vorlagenname: Geben Sie einen aussagekräftigen Namen für Ihre Vorlage ein. Dieser Name wird in der Vorlagenliste angezeigt, wenn Probleme an Jira gesendet werden. Beispiele: „A11Y Bug“, „Mobile Accessibility“, „WCAG 2.1 Verstöße“
2. Projekt: Wählen Sie das Jira-Projekt aus, in dem Probleme erstellt werden, wenn diese Vorlage verwendet wird. Die Dropdown-Liste zeigt alle Projekte an, in denen Sie Berechtigung haben, Probleme zu erstellen.
3. Problemtyp: Wählen Sie den Typ des Problems, das in Jira erstellt wird. Die verfügbaren Optionen hängen von der Konfiguration Ihres ausgewählten Projekts ab. Gängige Typen: Fehler, Aufgabe, Story, Teilaufgabe
4. Aktivieren Sie Axe-Problemscreenshots als Anhänge: Wenn aktiviert, werden von axe-Tools erstellte Screenshots automatisch dem Jira-Ticket angehängt. Dies bietet Entwicklern, die die Probleme beheben, einen visuellen Kontext.

Feldzuordnung konfigurieren

Auf der Seite zur Feldzuordnung kann der Benutzer axe-Felder auf Jira-Felder abbilden, um Daten von Zugänglichkeitsproblemen beim Erstellen von Tickets automatisch zu übertragen:

1. Wählen Sie im Dropdown-Menü Jira-Feld das Jira-Feld aus, das Sie zuordnen möchten
2. Wählen Sie im Dropdown-Menü axe-Feld das entsprechende axe-Datenfeld aus
3. Klicken Sie auf + Axe-Feld hinzufügen, um zusätzliche Felder zuzuordnen
4. Klicken Sie auf die Minus-Taste (−), um eine Zuordnung zu entfernen
5. Klicken Sie auf die Schaltfläche Weiter, um zu speichern

Wichtig: Alle erforderlichen Jira-Felder (z.B. Zusammenfassung) werden auf dieser Seite automatisch angezeigt. Wenn Sie diese nicht mit axe-Feldern abgleichen, werden die Benutzer bei der Übermittlung von Problemen aufgefordert, diese manuell auszufüllen.

Gängige axe-Felder, die zur Zuordnung verfügbar sind, umfassen:

1. Regel: die ID der Zugänglichkeitsregel, die verletzt wurde
2. Beschreibung: detaillierte Beschreibung des Zugänglichkeitsproblems
3. Wie man es behebt: Anweisungen zur Behebung des Problems
4. Hilfe URL: Link zur Regeldokumentation
5. Problembeschreibung: kurze Zusammenfassung des Problems
6. Selektor: CSS-Selektor für das Element
7. Elementquelle: HTML-Quellcode des Elements
8. Problem Screenshot-URL: die URL des Screenshots, der mit dem Problem verbunden ist
9. Tags: Array von String-Tags der Metadaten für das Problem (Kategorien, WCAG-Checkpoint-Identifikatoren, etc.)
10. Testname: Name des gespeicherten Tests, in dem das Problem gefunden wurde
11. Problem teilen URL: direkter Link zum geteilten Problem im Axe-Produkt
12. Erstellt am: das Datum, an dem das Problem erkannt wurde
13. Test-URL des Problems: URL der getesteten Seite
14. Gefunden von: Benutzer, der den Test durchgeführt hat, bei dem das Problem auftrat
15. Seitentitel: Dokumenttitel der getesteten Seite
16. Axe-Version: die axe-core-Version, die für den Test verwendet wurde

Jira-Beschreibungsfeld

Das Jira-Beschreibungsfeld folgt einer standardisierten Struktur, die nicht angepasst oder abgebildet werden kann. Wenn Probleme an Jira gesendet werden, enthalten sie automatisch eine strukturierte Beschreibung mit den folgenden Abschnitten:

• Problembeschreibung: Beschreibung des Problems
• Wie man es behebt: schrittweise Anleitungen zur Behebung
• Problemort:
  • Selektor: CSS-Selektor des Elements mit dem Problem
  • Elementquelle: HTML-Quellcode des Elements mit dem Problem
• Seiten-URL: URL der getesteten Seite
• Zusätzliche Details:
  • Auswirkung: Schweregrad des Problems
  • Axe-Issue-Link: Link zum Problemmeldungsbericht im Axe Account Portal (falls verfügbar)
  • Regelhilfe: Link zur Regeldokumentation

Impact-Mapping konfigurieren

Barrierefreiheitsprobleme in Axe werden nach Einflussstufen klassifiziert, die angeben, wie stark sie die Benutzer beeinflussen. Auf der Impact-Mapping-Seite können Sie diese Einflussstufen Ihren Jira-Prioritätswerten zuordnen, um eine ordnungsgemäße Priorisierung der Probleme sicherzustellen.

Fehlerbehandlung

Validierung erforderlicher Felder

Wenn ein erforderliches Feld in der Vorlage leer gelassen wird

Während der Problemübermittlung zeigt das System eine Fehlermeldung an und Benutzer müssen einen Wert für das erforderliche Feld angeben, bevor das Problem an Jira gesendet wird. Ein Axe-Problem kann nicht an Jira gesendet werden, bis alle erforderlichen Felder Werte haben.

Wenn eine Vorlage einen Wert einem erforderlichen Jira-Feld zuordnet, der Wert jedoch nicht in allen Axe-Produkten existiert

• Während der Vorlagenerstellung zeigt das System eine Warnmeldung an, dass das zugeordnete Feld nicht in allen Axe-Produkten verfügbar ist, aber Benutzer können mit der Erstellung der Vorlage fortfahren, trotz der Warnung.
• Beim Senden von Problemen an Jira, wenn eine Vorlage Zuordnungen zu Feldern enthält, die in einem Deque-Produkt fehlen, erscheint eine Warnmeldung. Das System hebt die Felder hervor, die eine manuelle Eingabe erfordern, und die Benutzer müssen manuell Werte für alle fehlenden erforderlichen Felder eingeben, bevor das Problem gesendet werden kann. Probleme werden erst an Jira gesendet, wenn alle erforderlichen Felder ausgefüllt sind – entweder durch bestehende Zuordnungen oder manuelle Eingabe.

Bearbeiten und Löschen von Vorlagen

Um eine Vorlage zu bearbeiten oder zu löschen, aktivieren Sie das „Optionen“-Menü für die betreffende Vorlage und Sie erhalten 2 Optionen:

• Vorlage bearbeiten
• Vorlage löschen