Was ist der Arbeitsbereich "Änderungen"?

Der Arbeitsbereich "Änderungen" ist dein Ort, um dein Help Center mit deinem Produkt synchron zu halten. Er sammelt alles, was in deinen verbundenen Repositories angekommen ist, beschreibt jede Änderung in verständlicher Sprache, prüft sie gegen deine Dokumentation und hält die Dokumentationsvorschläge bereit, bis jemand sie genehmigt. Du findest ihn als Änderungen unter Verwalten in der Seitenleiste. Früher hieß er Handoff.

Die Ansichten

Die Ansichtsliste auf der linken Seite sortiert deine Änderungen in Regale, damit du dich auf den Bereich konzentrieren kannst, der dich gerade interessiert.

"Neue Einträge": Zeigt die Anzahl ungelesener Änderungen an. Wenn keine Änderung ausgewählt ist, zeigt der Detailbereich eine kurze Nachricht für dich, wie "Du bist auf dem aktuellen Stand." oder "N Änderungen seit Dienstag.", mit Änderungen gruppiert nach Tag ("Heute", "Gestern", Wochentagsnamen). Ein Link "N brauchen deine Aufmerksamkeit" führt zu "Überprüfung erforderlich".

"Überprüfung erforderlich": Zeigt immer die Anzahl an, einschließlich null. Wenn dort "Nichts braucht deine Aufmerksamkeit." steht, wartet nichts auf dich.

"Alle Änderungen": Der komplette Verlauf der Änderungen.

"In der Dokumentation" und "Nicht für die Dokumentation": Gruppiert Änderungen nach ihrem Dokumentationsergebnis. "Nicht für die Dokumentation" enthält die Änderungen, die jemand explizit als solche gekennzeichnet hat.

Die Änderungsliste

Die mittlere Spalte listet die Änderungen in der Ansicht auf, die du geöffnet hast, mit dem Namen der Ansicht und der Zeilenanzahl oben. Mit einem Filterstreifen kannst du nach dem Help Center suchen und filtern.

Jede Zeile zeigt die Überschrift der Änderung plus eine Zeile mit einem "neu"-Marker für ungelesene Elemente, Help-Center-Punkte, die Zeit, Zielgruppen-Tags und einen Status-Chip. Zeilen sind unter Wochenüberschriften gruppiert. Wenn eine Ansicht leer ist, teilt sie dir das deutlich mit, zum Beispiel "Noch keine Einträge in der Dokumentation."

Die Änderungsdetails

Öffne eine Änderung und der Detailbereich zeigt, was es ist und wie es um die Dokumentation steht.

Eine Änderung ist eine Produktänderung, wie du sie einer Person erklären würdest, und sie kann aus mehreren zusammenhängenden Teilen bestehen. Die einzelnen Deltas sitzen zusammen unter einem aufklappbaren Bereich "Teile (N)", damit du sie als eine Änderung überprüfst, anstatt durch separate Commits zu suchen.

Die Hauptkarte enthält den Titel der Änderung und eine verständliche Beschreibung, gefolgt von einer Zeile "Wer nimmt das wahr:" und einer Zeile "Für den Support:". Wenn die Änderung hinter einem Feature-Flag sitzt, wird das angegeben. Chips unter dem Titel zeigen den Änderungstyp, die Absicht, die Oberfläche, die Zielgruppen, den Umfang, einen "gekennzeichnet"-Chip für gesperrte Releases, einen "Hauptversion"-Chip, wo zutreffend, und das Help-Center-Badge.

Der Bereich Dokumentation kommt zuletzt und ist zunächst eingeklappt. Seine Kopfzeile enthält einen Status-Chip, der anzeigt, wo die Dokumentationsarbeit für die Änderung steht. Wenn du ihn öffnest, erklärt er dir diesen Status, bietet ein "Artikel hinzufügen"-Formular mit den Modi "Bestehender Artikel" und "Neuer Artikel" und zeigt den Änderungssatz darunter.

Dokumentationsvorschläge und der Änderungssatz

Ein Änderungssatz ist die Menge der Dokumentationsvorschläge für eine Änderung: die Artikelupdates, die der Arbeitsbereich auf Basis des ausgelieferten Inhalts vorschlägt. Du kannst einen Vorschlag in seiner Karte bearbeiten und ihn dann akzeptieren oder verwerfen. Akzeptierte Vorschläge können auf ein Help Center angewendet werden.

All das geschieht über die Aktionsleiste am unteren Rand des Detailbereichs. Ihre linke Seite gibt an, worauf die Änderung wartet. Der primäre Button ändert sich je nach Status und zeigt "Vorschläge erstellen", "Alle akzeptieren (N)", "Alle anwenden (N)", "Änderungssatz schließen" oder "Erneut versuchen" nach einem Fehler an. Weniger auffällige Buttons wie "Neu planen", "Erneut prüfen", "Alle verwerfen" und "Artikel hinzufügen" sitzen daneben. Der Bereich "Dokumentation" ist zum Lesen da. Jede Änderung, die du machst, geht durch die Leiste.

Wenn eine Änderung mehrere Help Centers betrifft, wird eine Reihe von Help-Center-Tabs im Detailbereich angezeigt. Wenn du einen auswählst, wechselst du, auf welches Help Center sich der Bereich "Dokumentation" und seine Vorschläge beziehen.

Für den vollständigen Überprüfungs- und Anwendungs-Workflow siehe "Wie du deine Hilfeartikel nach jedem Produktupdate aktualisierst".

Eine Änderung ausblenden vs. "Nicht für die Dokumentation"

Beide befinden sich im Überlaufmenü der Aktionsleiste und bedeuten unterschiedliche Dinge.

"Nicht für die Dokumentation" ist eine Entscheidung. Sie dokumentiert, dass eine Änderung keine Dokumentation braucht. Sie fragt dich nach einem Grund und, wenn die Änderung mehrere Help Centers betrifft, ob die Entscheidung überall oder nur beim aktuellen Help Center gilt. Diese Änderungen erscheinen dann in der Ansicht "Nicht für die Dokumentation".

"Ausblenden" entfernt eine Änderung aus den Regalen, ohne eine Dokumentationsentscheidung zu protokollieren. Eine ausgeblendete Änderung bietet "Einblenden" an, um sie zurückzubringen.

Verfügbarkeit

Jeder mit Zugriff kann Änderungen, ihre Beschreibungen und ihren Dokumentationsstatus lesen. Das Erstellen, Bearbeiten, Akzeptieren, Anwenden, Ausblenden und Markieren von Änderungen ist auf Admins beschränkt. Im Nur-Lesen-Modus wird die Aktionsleiste nicht angezeigt. Änderungen erscheinen erst, nachdem Git-Quellen verbunden und unter Einstellungen → Git-Quellen analysiert wurden.