Code zu Doku

Aus jedem Release wird aktuelle Doku

Git Handoff von HappySupport liest jeden Merge in deinem Repository und beschreibt in einem Satz, was sich für deine Nutzer ändert. Deshalb siehst du sofort, welche Hilfeartikel nicht mehr stimmen, und bekommst den fertigen Entwurf gleich dazu. Du prüfst die markierten Stellen und übernimmst sie mit einem Klick.

Der Bereich Changes in HappySupport für Pipely, ein Vertriebstool: Links neun Produktänderungen, die geprüft werden wollen. Rechts die Änderung „Contacts can be owned by a whole team“ mit dem aufgeklappten Entwurf für den Artikel „Assign a contact to an owner“: Der alte Satz in Schritt 3 ist durchgestrichen, der neue Text zu Teams als Besitzer grün markiert, darunter der Button „Apply all (3)“

Kurz gesagt

Was Git Handoff von HappySupport macht

Git Handoff ist der Teil von HappySupport, der deine Doku mit dem Code abgleicht. Er liest die Commits und gemergten Pull Requests in deinem GitHub- oder GitLab-Repository, fasst sie zu Produktänderungen zusammen und prüft für jede Änderung, welche Hilfeartikel sie betrifft. Für jeden betroffenen Artikel schreibt HappySupport einen Entwurf, der nur die falschen Stellen ändert, und für fehlende Themen einen neuen Artikel. Nichts geht live, bevor jemand aus deinem Team es übernimmt.

Git Handoff ist bei HappySupport ab Professional enthalten, für 399 Euro im Monat bei jährlicher Abrechnung (479 Euro bei monatlicher Abrechnung), zzgl. MwSt., pauschal statt pro Nutzer. Jeden Tarif kannst du 14 Tage kostenlos und ohne Kreditkarte testen.

Diese Teams dokumentieren mit HappySupport

So funktioniert es

Vom Merge zum aktualisierten Artikel

Niemand muss sich merken, welcher Artikel nach welchem Release angepasst werden muss. HappySupport liest mit, was dein Team ausliefert, und legt dir die Arbeit fertig vor.

Pull Request #482 in main gemergt

a41c9e2feat(contacts): allow a team as owner
7d02b18feat(forms): round robin for team owners
c93f5aachore(deps): bump eslint to 9.4ignoriert

1. Repository verbinden

Du verbindest GitHub oder GitLab mit einem Zugriffstoken und wählst den Branch, der live geht. HappySupport legt den Webhook selbst an, deshalb wird jeder Push und jeder gemergte Pull Request ohne weiteres Zutun gelesen. Refactorings, Tests und Dependency-Updates sortiert HappySupport aus, damit du nur Änderungen siehst, die deine Nutzer bemerken.

Eine Änderung im Bereich Changes: Titel „Contacts can be owned by a whole team“, eine Zusammenfassung in Klartext, die Zeile „Who notices“ und die Kennzeichnung als Feature für Users, Admins und Sales

2. Änderung verstehen

Aus den Commits wird eine Produktänderung in Klartext: was sich geändert hat, wer es bemerkt und für welche Rolle es wichtig ist. Gehören mehrere Pull Requests zum selben Feature, fasst HappySupport sie zu einer Änderung zusammen. So versteht auch dein Support, was ausgeliefert wurde, ohne den Code zu lesen.

Der Dialog „Publish or keep as draft“ in HappySupport: Ein neuer Artikel steht auf Draft, zwei Änderungen an veröffentlichten Artikeln gehen direkt live

3. Entwürfe prüfen und übernehmen

Zu jeder Änderung liegen die Entwürfe für alle betroffenen Artikel bereit. Mit „Apply all“ übernimmst du sie auf einmal und entscheidest für neue Artikel, ob sie sofort veröffentlicht werden oder als Entwurf warten. Deshalb ist die Doku am Tag des Releases aktuell, nicht Wochen später.

Probier es mit deinem eigenen Repository aus

Gib deine Website ein, und HappySupport richtet dein Hilfecenter in deinem Branding ein. Danach verbindest du GitHub oder GitLab, und die Änderungen der letzten 30 Tage erscheinen im Bereich Changes.

Diese Teams dokumentieren mit HappySupport

Gezielte Entwürfe

Nur die Sätze, die nicht mehr stimmen

HappySupport schreibt betroffene Artikel nicht neu. Der Entwurf verankert jede Änderung an der Stelle im Artikel, die durch den Code falsch geworden ist, und lässt den Rest unangetastet. Deshalb prüfst du drei markierte Sätze statt einen ganzen Artikel.

Mit deinem Repository testen

Der aufgeklappte Entwurf für den Pipely-Artikel über das Zuweisen von Kontakten: Drei Stellen sind geändert, gestrichener Text rot, neuer Text grün, der Rest des Artikels ist als unveränderte Zeilen eingeklappt

Jede Änderung an ihrer Stelle
Gestrichener und neuer Text stehen direkt im Artikel, unveränderte Abschnitte sind eingeklappt. Mit den Pfeilen springst du von Änderung zu Änderung, und eine einzelne Änderung kannst du verwerfen, ohne den Rest zu verlieren.
Ein zweites Modell prüft gegen
Bevor du einen Entwurf siehst, prüft ein zweites KI-Modell jede Änderung gegen die Code-Änderung. Was es nicht belegen kann, fliegt raus oder wird für dich markiert. So landen weniger Vermutungen in deiner Doku.
Direkt im Entwurf nachbessern
Der Entwurf ist ein normaler Editor. Du änderst ein Wort, ergänzt einen Hinweis oder schreibst HappySupport, was anders sein soll, und bekommst einen neuen Entwurf. Erst beim Übernehmen wird der Artikel geschrieben.

Bei jeder Änderung

Mehr als Artikel-Updates

Nicht jede Änderung passt in einen bestehenden Artikel, und nicht jede braucht Doku. HappySupport deckt auch diese Fälle ab, damit nichts liegen bleibt.

Eine Lücke ohne passenden Artikel mit dem Button zum Schreiben, darunter ein Entwurf für den Artikel über das Schließen von Deals und ein weiterer Artikelvorschlag zu den Gründen für verlorene Deals

Fehlende Artikel und Ideen

Findet HappySupport keinen Artikel, in den eine Neuerung gehört, markiert es sie als „Needs a home“. Mit „Write“ recherchiert HappySupport im Code und schreibt einen neuen Artikel, mit „Record“ nimmst du den Ablauf selbst auf. Darunter stehen weitere Artikel, die zu dieser Änderung passen würden, als Vorschläge zum Schreiben oder Verwerfen.

Das Menü zum Überspringen einer Änderung mit sechs Gründen, darunter Bugfix, schon abgedeckt, zu klein und keine Produktänderung

Überspringen mit Begründung

Braucht eine Änderung keine Doku, klickst du auf „Skip“ und wählst den Grund, etwa Bugfix oder schon abgedeckt. Die Änderung verschwindet aus deiner Liste, und dein Team sieht später, warum.

Neu26. Oktober

Kontakte können einem ganzen Team gehören

Wähle im Feld Besitzer ein Team, und neue Kontakte aus Webformularen gehen reihum an seine Mitglieder.

Changelog aus derselben Änderung

Mit dem Megafon in der Leiste wird die Änderung zum Changelog-Eintrag. HappySupport schreibt den Entwurf, du veröffentlichst ihn im Hilfecenter, im Widget und als RSS-Feed, automatisch übersetzt.

HappySupportMo., 09:00

Was sich bei Pipely geändert hat: KW 44

11 Änderungen, 9 davon mit Doku-Entwürfen

HappySupportDi., 09:30

3 Entwürfe warten auf deine Prüfung bei Pipely

Nichts erreicht das Hilfecenter, bevor du es übernimmst.

Eine Mail, wenn Entwürfe warten

Montags fasst eine Mail zusammen, was in der letzten Woche ausgeliefert wurde. An Werktagen erinnert dich eine zweite Mail, wenn Entwürfe auf deine Prüfung warten. Beide schaltest du im Bereich Changes ein, deshalb musst du nicht täglich nachsehen, ob es etwas zu tun gibt.

Woher es liest

GitHub und GitLab

Du verbindest dein Repository mit einem persönlichen Zugriffstoken. HappySupport legt den Webhook an und liest danach jeden Push und jeden gemergten Pull Request auf dem Branch, den du auswählst.

GitHub

Für Repositories auf github.com. Das Token braucht die Rechte Contents und Webhooks. Deshalb kann HappySupport den Code lesen und den Webhook selbst anlegen, ohne dass du in den Repository-Einstellungen etwas einrichtest.

Verbinden

GitLab

Für Projekte auf gitlab.com. Das Token braucht die Scopes read_repository und api. Push und Merge Requests kommen über den Webhook an, deshalb landen Änderungen im Bereich Changes, sobald sie gemergt sind.

Verbinden

Bitbucket

Geplant

Bitbucket-Repositories lassen sich schon verbinden, Git Handoff liest ihre Commits aber noch nicht. Bis dahin nutzt du GitHub oder GitLab.

Auf die Warteliste

Nach dem Übernehmen

Ein Update, überall aktuell

Ein übernommener Entwurf ist ein normaler HappySupport Artikel. Deshalb zieht alles, was auf deinen Artikeln aufbaut, die neue Fassung automatisch nach.

Übersetzungen ziehen nach

Sobald du ein Update übernimmst, übersetzt HappySupport den Artikel neu in die Sprachen deines Hilfecenters. Deshalb lesen internationale Kunden die neue Anleitung am selben Tag wie deutsche.

Der KI-Chatbot antwortet richtig

Der KI-Chatbot im Hilfecenter und im Widget antwortet aus deinen Artikeln. Sind die Artikel aktuell, sind es auch seine Antworten, und er erklärt nicht mehr den Ablauf vom letzten Release.

Öffentlicher Changelog

Änderungen, die du mit dem Megafon markierst, erscheinen auf der Changelog-Seite deines Hilfecenters, im Changelog-Tab des Widgets und im RSS-Feed. Den Changelog schaltest du pro Hilfecenter ein.

Neue Abläufe aufnehmen

Braucht ein neuer Artikel Screenshots, startest du mit „Record“ den HappySupport Recorder. Die Aufnahme landet direkt im Artikel, den Git Handoff vorgeschlagen hat.

Auch für deinen KI-Assistenten

Über den MCP-Server von HappySupport liest ein Assistent wie Claude die offenen Änderungen und ihre Themen. So fragst du im Chat, was letzte Woche ausgeliefert wurde und welche Artikel noch offen sind.

Dein Team weiß, was live ist

Die Klartext-Beschreibungen helfen auch Support und Vertrieb. Wer die wöchentliche Mail abonniert, weiß, was sich geändert hat, bevor die erste Kundenfrage dazu kommt.

Kontrolle

Du entscheidest, was live geht

HappySupport schlägt vor, dein Team entscheidet. Diese Regeln gelten für jede Änderung.

Nichts ohne deine Freigabe

Entwürfe bleiben Entwürfe, bis jemand mit Admin-Rechten sie übernimmt. Neue Artikel starten als Entwurf, außer du stellst sie beim Übernehmen auf Veröffentlichen.

Kein Rauschen aus dem Code

Refactorings, Tests, Formatierung und Dependency-Updates erzeugen keine Änderung. Ein Revert hebt die Änderung auf, die er zurücknimmt, deshalb bleibt die Liste kurz.

Hinter Feature-Flags erkannt

Liegt ein Feature hinter einem Feature-Flag, sagt die Änderung das dazu. Du weißt also, dass es gemergt, aber vielleicht noch nicht für alle sichtbar ist, und wartest mit dem Veröffentlichen.

Mehrere Hilfecenter

Verbindest du einen Branch mit mehreren Hilfecentern, wird die Änderung einmal beschrieben und für jedes Hilfecenter getrennt geprüft. Jedes hat eigene Entwürfe und einen eigenen Status.

Die letzten 30 Tage sofort

Nach dem Verbinden holt HappySupport 90 Tage Historie und analysiert die letzten 30 Tage. Deshalb siehst du am ersten Tag, was deine Doku seit dem letzten Monat verpasst hat.

Zugriff, den du zurücknimmst

Das Token wird verschlüsselt gespeichert. Entfernst du das Repository, löscht HappySupport auch die lokale Kopie des Codes.

Doku, die mit deinem Produkt mitwächst

Git Handoff ist ein Teil davon. Diese Seiten zeigen den Rest.

Betroffene Artikel finden

Wie HappySupport erkennt, welche Artikel eine Änderung veralten lässt.

Selbst aktualisierende Doku

Warum Doku veraltet und wie du sie ohne Extra-Aufwand aktuell hältst.

KI-Artikel-Recorder

Einmal durchklicken, fertigen Artikel mit Screenshots erhalten.

Preise

Was Starter, Professional und Scale enthalten, von Git Handoff bis zu Übersetzungen.

FAQ

Git Handoff von HappySupport im Detail

Welche Repositories, welche Rechte, was es kostet und was nie ohne dich passiert.

Gibt es eine kostenlose Version von HappySupport mit Git Handoff?+

Nein, HappySupport hat keinen kostenlosen Tarif, auch nicht für den Helpdesk. Git Handoff ist ab Professional für 399 Euro im Monat enthalten und bei Scale für 899 Euro, bei jährlicher Abrechnung (bei monatlicher Abrechnung 479 oder 1.079 Euro), jeweils zzgl. MwSt., pauschal statt pro Nutzer. Du kannst jeden Tarif 14 Tage kostenlos testen, ohne Kreditkarte, und Git Handoff in dieser Zeit mit deinem eigenen Repository ausprobieren.

Welche Git-Anbieter unterstützt HappySupport Git Handoff?+

GitHub und GitLab, jeweils in der Cloud-Version auf github.com und gitlab.com. Bitbucket-Repositories lassen sich verbinden, Git Handoff liest ihre Commits aber noch nicht. Selbst gehostete GitLab-Instanzen werden derzeit nicht unterstützt.

Welche Rechte braucht HappySupport auf meinem Repository?+

Du verbindest das Repository mit einem persönlichen Zugriffstoken. Auf GitHub braucht es die Rechte Contents und Webhooks, auf GitLab die Scopes read_repository und api. Die Webhook-Rechte braucht HappySupport, um den Webhook selbst anzulegen. In deinen Code schreibt HappySupport nichts, das Token wird verschlüsselt gespeichert.

Wann prüft HappySupport meine Commits?+

Sofort nach jedem Push und jedem gemergten Pull Request, über den Webhook. Zusätzlich holt HappySupport jede Nacht um 3 Uhr UTC neue Commits nach, und im Bereich Changes kannst du jederzeit aktualisieren. Analysiert werden Änderungen der letzten 30 Tage, ältere nicht.

Veröffentlicht HappySupport Änderungen an meiner Doku automatisch?+

Nein. HappySupport schreibt die Entwürfe automatisch, übernommen werden sie erst, wenn jemand mit Admin-Rechten auf „Apply all“ klickt. Dabei entscheidest du für neue Artikel, ob sie veröffentlicht werden oder als Entwurf warten; voreingestellt ist Entwurf. Änderungen an bereits veröffentlichten Artikeln gehen beim Übernehmen live.

Liest HappySupport nur die Diffs oder meinen ganzen Code?+

Beides. Die Analyse liest die Diffs der Commits. Für Entwürfe und neue Artikel liest HappySupport bei Bedarf weitere Dateien aus einer Kopie deines Repositorys, etwa um einen Button-Text oder eine Einstellung nachzuschlagen. Die Kopie wird gelöscht, wenn du das Repository oder den Anbieter entfernst.

Woran erkennt HappySupport, dass eine Änderung keine Doku braucht?+

Refactorings, Tests, Formatierung und Dependency-Updates sortiert HappySupport aus, bevor eine KI sie liest. Bei den übrigen Änderungen prüft HappySupport, ob ein Artikel durch sie falsch wird, und muss die betroffene Stelle zitieren können. Gelingt das nicht, wird kein Artikel geändert. Was trotzdem in deiner Liste landet, überspringst du mit einem Grund.

Macht HappySupport aus Code-Änderungen auch Release Notes?+

Ja. Mit dem Megafon wird eine Änderung zum Changelog-Eintrag, den HappySupport als Entwurf schreibt. Veröffentlicht erscheint er auf der Changelog-Seite deines Hilfecenters, im Changelog-Tab des Widgets und im RSS-Feed, automatisch übersetzt.

Aktualisiert Git Handoff auch Screenshots?+

Nein, Git Handoff ändert den Text deiner Artikel. Für neue Abläufe startest du aus dem Vorschlag heraus den HappySupport Recorder. Einzelne Screenshots nimmt HappySupport bei Professional und Scale in einem Cloud-Browser neu auf; diese Funktion ist in der Beta und läuft unabhängig von Git Handoff.

Verbinde dein Repository noch heute

Gib deine Website ein und verbinde danach dein Repository. Die ersten Entwürfe liegen bereit, bevor du sie suchst.