So aktualisierst du deine Hilfeartikel nach jedem Produktrelease

Es ist essentiell, deine Hilfedokumentation mit Produktveränderungen auf dem aktuellen Stand zu halten, um deinen Nutzern einen genauen Support 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 hat.

Erste Schritte

1. Navigiere zum Handoff-Bereich
   Klick auf "Handoff" in der linken Navigationsleiste unter dem Bereich "Maintain". Das öffnet dir 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 einem Branch verbunden werden. Du kannst alle Help Centers oder spezifische auswählen, um deren eingehende Änderungen anzusehen.

Änderungen analysieren

3. Überprüfe eingehende Commits
   Klick auf "Refresh", um die neuesten Commits deines Entwicklungsteams zu sehen. Die Commits sind nach Datum organisiert und zeigen dir alle kürzlichen Änderungen, die deine Dokumentation beeinflussen könnten.

4. Analysiere relevante Commits
   Klick auf den "Analyze"-Button neben einer Commit-Gruppe (wie "Yesterday - 9 commits"). Das System prüft, ob diese Änderungen dokumentationswürdig sind, und fasst zusammen, was sich in jedem Commit geändert hat. So kannst du es leicht verstehen, auch wenn du kein Entwickler bist.

5. Verwirf irrelevante Änderungen
   Einige Commits beeinflussen deine Dokumentation nicht, wie zum Beispiel CSS-Farbänderungen. Klick auf "Dismiss" bei diesen Elementen, um sie aus deiner Warteschlange zu entfernen.

Dokumentationsupdates verarbeiten

6. Übergib relevante Änderungen
   Für Commits, die deine Dokumentation beeinflussen, klick auf den "Handoff"-Button. Das öffnet dir ein Fenster, in dem du zusätzliche Kontextinformationen oder Anweisungen für das Dokumentationsupdate hinzufügen kannst, wenn nötig.

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

7. Überprüfe vorgeschlagene Updates
   Das System stellt fest, ob du vorhandene Artikel aktualisieren, neue erstellen oder veraltete Support-Artikel löschen musst. Jedes Element ist mit PATCH (aktualisieren), CREATE (neu) oder DELETE gekennzeichnet, basierend auf der erforderlichen Aktion.

6. Generiere Inhaltsvorschläge
   Klick auf "Generate" neben einem Element (1 Element = 1 Artikel-Aufgabe), um vorgeschlagene Änderungen zu sehen. Das System schlägt spezifische Änderungen an deinen Artikeln basierend auf den Produktveränderungen vor.

6. Überprüfe und akzeptiere Änderungen
   Klick auf "Review", um die vorgeschlagenen Änderungen im Detail zu sehen. Das System zeigt entfernten Text durchgestrichen und neue Ergänzungen in grüner Hervorhebung an. Zum Beispiel könnte es einen neuen Absatz über das Hochladen eines Favicons mit unterstützten Bildformaten hinzufügen.

6. Übernimm die Vorschläge
   Klick auf "Accept Suggestion", um die Änderungen in deinen Hilfeartikel zu übernehmen. Das System aktualisiert deine Dokumentation mit den neuen Informationen.

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

Nach Abschluss dieser Schritte ist deine Hilfedokumentation auf den neuesten Stand des Produktreleases aktualisiert. So stellst du sicher, dass deine Nutzer immer genaue und aktuelle Informationen haben.