Wie du deine Hilfeartikel nach jedem Produktrelease aktualisierst

Es ist essentiell, deine Hilfedokumentation mit Produktänderungen aktuell zu halten, um deinen Nutzern genaue Unterstützung zu bieten. Diese Anleitung zeigt dir, wie du die Handoff-Funktion nutzt, um Hilfeartikel zu identifizieren und zu aktualisieren, nachdem dein Entwicklungsteam neue Funktionen oder Updates veröffentlicht.

Erste Schritte

1. Navigiere zum Handoff-Bereich
   Klick auf "Handoff" in der linken Navigationsleiste unter dem Abschnitt "Maintain". Damit öffnest du die Handoff-Seite, auf der du alle eingehenden Änderungen deines Entwicklungsteams sehen kannst.

2. Wähle dein Help Center
   Klick auf das Help-Center-Badge (wie "HappySupport") im Handoff-Flow oben auf der Seite. Jedes Help Center kann mit einem GitHub-Repository oder einer Branch verbunden sein. Du kannst alle Help Centers oder spezifische auswählen, um ihre eingehenden Änderungen zu sehen.

Änderungen analysieren

3. Neue Commits abrufen
   Klick auf "Refresh", um die neuesten Commits aus deinem verbundenen GitHub- oder GitLab-Repository abzurufen. Dadurch werden auch Commits abgerufen, die zu Tagen hinzugefügt wurden, die du bereits analysiert hast. Die Commits sind nach Datum organisiert und zeigen dir alle aktuellen Änderungen, die deine Dokumentation beeinflussen könnten.

4. Relevante Commits analysieren
   Klick auf den "Analyze"-Button neben einer Commit-Gruppe. Eine Zeile mit der Bezeichnung "not analyzed yet" bedeutet, dass keine Commits für diesen Tag überprüft wurden. Eine Zeile mit einer Bezeichnung wie "3 commits since the last analysis" bedeutet, dass neue Commits nach deiner vorherigen Analyse eingegangen sind. Klick auf "Analyze" in der angezeigten Zeile, um diese Commits zu verarbeiten, bevor du zum Handoff und zur Überprüfung gehst.

5. Irrelevante Änderungen verwerfen
   Einige Commits beeinflussen deine Dokumentation nicht, wie z.B. CSS-Farbänderungen. Klick auf "Dismiss" bei diesen Elementen, um sie aus deiner Warteschlange zu entfernen.

Dokumentationsaktualisierungen verarbeiten

6. Relevante Änderungen übergeben
   Für Commits, die deine Dokumentation beeinflussen, klick auf den "Handoff"-Button. Dies öffnet ein Modal, in dem du zusätzlichen Kontext oder Anweisungen für die Dokumentationsaktualisierung hinzufügen kannst, falls erforderlich.

7. Bestätige den Handoff
   Klick auf den "Handoff"-Button im Modal, um zu bestätigen. Das System analysiert deine vorhandene Dokumentation und sucht nach jedem Artikel, der die geänderte Funktion erwähnt.

8. Überprüfe vorgeschlagene Updates
   Das System identifiziert, ob du vorhandene Artikel aktualisieren, neue erstellen oder veraltete Hilfeartikel löschen musst. Jedes Element wird je nach erforderlicher Aktion als PATCH (aktualisieren), CREATE (neu) oder DELETE (löschen) gekennzeichnet.

9. Generiere Inhaltsvorschläge
   Klick auf "Generate" neben einem Element (1 Element = ein Artikel), um vorgeschlagene Änderungen zu sehen. Das System wird spezifische Bearbeitungen deiner Artikel basierend auf den Produktänderungen vorschlagen.

10. Überprüfe und akzeptiere Änderungen
    Klick auf "Review", um die vorgeschlagenen Bearbeitungen im Detail zu sehen. Das System zeigt entfernte Texte durchgestrichen und neue Hinzufügungen grün hervorgehoben an. Beispielsweise könnte es einen neuen Absatz zum Hochladen eines Favicons mit unterstützten Bildformaten hinzufügen.

11. Übernimm die Vorschläge
    Klick auf "Accept Suggestion", um die Änderungen auf deinen Hilfeartikel anzuwenden. Das System aktualisiert deine Dokumentation mit den neuen Informationen.

12. Schließe weitere Updates ab
    Akzeptiere weitere Vorschläge für den betroffenen Artikel, um sicherzustellen, dass dein gesamtes Help Center die neuesten Produktänderungen widerspiegelt.

Nach dem Abschluss dieser Schritte ist deine Hilfedokumentation auf den neuesten Stand des Produktreleases aktualisiert, und deine Nutzer haben immer genaue und aktuelle Informationen zur Verfügung.