Automatische PR-Entwürfe
Automatische PR-Entwürfe halten Ihre Dokumentation mit Ihrem Produkt synchron. Wenn ein zusammengeführter Pull Request kundenrelevantes Verhalten ändert, erkennt Fern dies und erstellt automatisch einen Dokumentationsentwurf.
Diese Funktion verbindet Ihre GitHub-Integration mit Fern, sodass Dokumentationsaktualisierungen ohne manuelle Überwachung erfolgen. Sie überprüfen und genehmigen weiterhin jeden Entwurf, bevor er live geht.
So funktioniert es
Wenn Sie automatische PR-Entwürfe aktivieren, überwacht Fern zusammengeführte Pull Requests in Ihrem verbundenen GitHub-Repository. Falls ein Merge etwas ändert, das Ihre Kunden wissen müssen, erstellt Fern einen Entwurfsartikel oder eine Aktualisierung.
Der Entwurf erscheint auf Ihrer Fern-Seite als Thread mit einem Pull-Request-Symbol. Sie überprüfen ihn, nehmen bei Bedarf Änderungen vor und veröffentlichen ihn, wenn er bereit ist. Fern veröffentlicht niemals automatisch.
Voraussetzungen
GitHub-Integration verbunden – Fern benötigt Zugriff auf Ihr Repository, um Pull Requests zu überwachen. Falls Sie GitHub noch nicht verbunden haben, richten Sie zuerst die Integration ein zuerst.
Automatische PR-Entwürfe aktivieren
Go to Settings
Öffnen Sie die Einstellungen über die Seitenleiste in Ihrem Ferndesk-Dashboard.
Open Automations
Klicken Sie in der Einstellungs-Seitenleiste auf Automations. Diese Seite zeigt sowohl Einstellungen für automatische PR-Entwürfe als auch für geplante Audits.
Enable the toggle
Schalten Sie Automatic PR drafts auf Ein. Die Einstellung wird sofort gespeichert und Sie sehen eine Bestätigungsmeldung.
Nach der Aktivierung beginnt Fern mit der Überwachung zusammengeführter Pull Requests auf kundenrelevante Änderungen.
Was einen Entwurf auslöst
Fern entwirft eine Aktualisierung, wenn:
Ein Pull Request in Ihrem verbundenen GitHub-Repository zusammengeführt wird
Der Merge Änderungen am kundenrelevanten Verhalten enthält (UI-Flows, API-Endpunkte, Funktionsverhalten, Fehlermeldungen oder Konfigurationsoptionen)
Fern analysiert den Diff, um festzustellen, ob die Dokumentation aktualisiert werden muss. Falls die Änderung intern ist oder Kunden nicht betrifft, markiert Fern den Thread als „Keine Dokumentationsänderungen erforderlich“ und erstellt keinen Entwurf.
Sie können Durchläufe, bei denen Fern keine Entwürfe erstellt hat, sehen, indem Sie auf der Fern-Seite nach Automations filtern.
Ihre Entwürfe überprüfen
Wenn Fern einen Entwurf erstellt, erscheint dieser auf Ihrer Fern-Seite als Thread mit einem Pull-Request-Symbol. Der Thread zeigt:
Den PR-Titel und die Metadaten
Eine Zusammenfassung dessen, was sich geändert hat
Den Entwurfsstatus (in Bearbeitung, bereit zur Überprüfung oder Fehler)
Klicken Sie auf den Thread, um das Detailpanel zu öffnen. Wenn der Entwurf bereit ist, klicken Sie auf Review & edit changes, um zu sehen, was Fern geschrieben hat. Bearbeiten Sie den Entwurf direkt, fordern Sie Überarbeitungen an, indem Sie Fern im Thread eine Nachricht senden, oder veröffentlichen Sie ihn, wenn Sie zufrieden sind.
Sie können die Fern-Thread-Liste filtern, indem Sie Has drafts auswählen, um nur Threads mit zur Überprüfung bereiten Entwürfen anzuzeigen.
Sie kontrollieren die Veröffentlichung
Fern entwirft Aktualisierungen, veröffentlicht diese jedoch niemals automatisch. Jeder Entwurf erfordert Ihre Überprüfung und Genehmigung, bevor er in Ihrem Help Center erscheint. Dies gibt Ihnen die volle Kontrolle darüber, was live geht, während die manuelle Arbeit der Überwachung von Pull Requests entfällt.
Verwandte Artikel
Wie Fern Artikel erstellt – der Entwurfs- und Überprüfungs-Workflow