Eine Änderung prüfen und eine Dokumentationsentscheidung festhalten

Wenn eine Produktänderung keine Aktualisierung der Dokumentation erfordert, kannst du diese Entscheidung direkt im Changes-Arbeitsbereich festhalten. Dadurch wird die Änderung als "not for the docs" markiert, aus deiner Prüfliste entfernt und dokumentiert, warum sie übersprungen wurde.

Du benötigst die Berechtigung, Änderungen in deiner Organisation anzuwenden. Ohne diese Berechtigung wird die Aktionsleiste nicht angezeigt. Wenn kein Code-Repository verbunden ist, zeigt der Arbeitsbereich stattdessen die Aufforderung "Connect codebase" an.

Die Änderung öffnen

1. Den Changes-Arbeitsbereich öffnen
   Klicke in der Hauptnavigation auf "Changes". Der Arbeitsbereich wird in der Ansicht "What's new" geöffnet. Wenn du dich auf Änderungen konzentrieren möchtest, für die noch eine Entscheidung aussteht, klicke links in der Ansichtsliste auf "Needs review".

2. Eine Änderung auswählen
   Klicke auf die Änderung, die du prüfen möchtest. Die Details werden neben der Liste angezeigt. Oberhalb des Abschnitts "Documentation" siehst du die Zusammenfassung der Änderung und den Namen des Help Centers.

3. Die Help-Center-Tabs prüfen
   Wenn die Änderung mehr als ein Help Center betrifft, werden oberhalb von "Documentation" Tabs angezeigt. Wähle das Help Center aus, das du gerade prüfst, bevor du eine Entscheidung festhältst.

Die vorgeschlagene Aktion prüfen

4. Die Aktionsleiste lesen
   Die Aktionsleiste befindet sich unten im Detailbereich. Die hervorgehobene Schaltfläche rechts zeigt die vom Arbeitsbereich vorgeschlagene nächste Aktion für diese Änderung. Ihre Beschriftung hängt vom Status der Änderung ab: "Create proposals", wenn die Dokumentation noch nicht geprüft wurde, oder "Skip", wenn der Planer davon ausgeht, dass keine Aktualisierung der Dokumentation erforderlich ist. Wird die Änderung noch geprüft, zeigt die Leiste eine Fortschrittsmeldung und die Aktionen sind nicht verfügbar.

5. Die Empfehlung des Planers prüfen
   Wenn "Skip" als Aktion vorgeschlagen wird, zeigt die linke Seite der Leiste die Empfehlung des Planers an. Der vorgeschlagene Grund ist im Menü "Skip" bereits ausgewählt.

Eine Skip-Entscheidung festhalten

6. Das Menü "Skip" öffnen
   Klicke in der Aktionsleiste auf "Skip". Wenn "Skip" vorgeschlagen wird, ist die Option die hervorgehobene Schaltfläche rechts. Andernfalls erscheint sie unter den weniger hervorgehobenen Optionen. Oberhalb der Leiste öffnet sich ein Menü mit der Überschrift "No docs for this, because it is…"

7. Einen Grund auswählen
   Wähle den Grund aus, der am besten erklärt, warum diese Änderung keine Dokumentation benötigt. Folgende Gründe stehen zur Auswahl:

   • "Bug fix": Stellt wieder her, was in der Dokumentation beschrieben ist.
   • "Nothing a reader sees": Für Leserinnen und Leser ist keine Änderung sichtbar.
   • "Already covered": Das Help Center erklärt es bereits.
   • "Too small": Eine Änderung am Artikel lohnt sich nicht.
   • "Another product": Betrifft ein anderes Produkt oder eine andere Website.
   • "Not a product change": Betrifft ein Refactoring, CI oder eine Abhängigkeit.

   Du musst keine Felder ausfüllen und keine schriftliche Begründung angeben. Wenn für die Änderung offene Vorschläge vorliegen, werden diese beim Überspringen verworfen.

8. Den Geltungsbereich des Help Centers festlegen
   Wenn die Änderung mehr als ein Help Center betrifft, enthält das Menü eine Einstellung für den Geltungsbereich. Bei Gründen, die zwangsläufig überall gelten ("Bug fix", "Nothing a reader sees", "Not a product change"), steht im Menü "In all [number] Help Centers". Diese Einstellung lässt sich nicht ändern. Bei den anderen Gründen ("Already covered", "Too small", "Another product") kannst du über ein Kontrollkästchen mit der Beschriftung "For all [number] help centers" festlegen, ob die Entscheidung für alle Help Center oder nur für das aktuelle gelten soll. Aktiviere oder deaktiviere das Kontrollkästchen, bevor du den Grund auswählst.

   Wenn nur ein Help Center betroffen ist, wird keine Auswahl für den Geltungsbereich angezeigt.

Die Eingabetaste verwenden

9. Die Eingabetaste für die vorgeschlagene Aktion drücken
   Wenn "Skip" als Aktion vorgeschlagen wird, öffnet sich mit der Eingabetaste das Menü zur Auswahl eines Grundes. Sobald der vorgeschlagene Grund ausgewählt ist, kannst du ihn durch erneutes Drücken der Eingabetaste bestätigen. Die Eingabetaste löst keine Aktion aus, während du tippst, ein Textfeld oder ein anderes Steuerelement den Fokus hat, ein Menü oder Dialogfeld geöffnet ist oder eine Tastenkombinationstaste gedrückt gehalten wird. Während eine Aktion ausgeführt wird, sind Schaltflächen ebenfalls nicht verfügbar.

Eine Entscheidung ansehen und rückgängig machen

10. Die festgehaltene Entscheidung prüfen
    Nachdem du einen Grund ausgewählt hast, wird die Entscheidung gespeichert, die Änderung aus der Prüfliste entfernt und automatisch die nächste nicht übersprungene Änderung geöffnet. Auf der linken Seite der Aktionsleiste wird der festgehaltene Grund angezeigt. Die Entscheidung bleibt sichtbar, solange sie gültig ist.

11. Die Details der Entscheidung ansehen
    Bewege den Mauszeiger über die in der Aktionsleiste angezeigte Entscheidung. Ein Popup mit Details zeigt, wer die Entscheidung getroffen hat, an welchem Datum und welche ursprüngliche Empfehlung der Planer gegeben hat.

12. Die Entscheidung rückgängig machen
    Klicke im Popup mit den Details auf "Undo". Dadurch wird die Dokumentationsfrage für dieselbe Änderung erneut geöffnet und die Änderung wieder in deine Prüfliste aufgenommen. Mit "Undo" werden Vorschläge, die beim Überspringen der Änderung verworfen wurden, nicht wiederhergestellt. Sie bleiben verworfen.

Wenn eine Entscheidung nicht gespeichert werden kann, zeigt der Arbeitsbereich eine Fehlermeldung mit dem Titel "Updating the change failed" und der verfügbaren Fehlermeldung an. Eine umfassendere Übersicht über den Arbeitsbereich und seine Ansichten findest du unter Was ist der Changes-Arbeitsbereich?.