Code-verankerte Dokumentation

Code-verankerte Dokumentation ist die Methode, mit der HappySupport Help-Center-Anleitungen aktuell hält. Jeder im Browser aufgezeichnete Schritt einer Anleitung ist an eine DOM- oder CSS-Selektorkette geknüpft, die bei der Aufnahme erfasst wurde.

Ändert sich der Frontend-Quellcode des Kunden im verbundenen Repository, erkennt Git Handoff die betroffenen Anleitungen und schlägt Updates vor. Das Team prüft und übernimmt sie.

Entity-Klasse

Methode

Genutzt von

HappySupport Suite

Erstellt

2026-10-01

Aktualisiert

2026-10-01

Geprüft

2026-10-01

Sprache

DE · EN

Code-verankerte Dokumentation: Entity-Übersicht

Entity-Klasse: Methode
Genutzt von: HappySupport Suite
Anker: Eine DOM- oder CSS-Selektorkette pro Schritt der Anleitung
Erfasst durch: HappyRecorder bei der Aufnahme im Browser
Änderungserkennung: Git Handoff analysiert Commits im verbundenen Repository
Git-Anbieter: GitHub, GitLab, Bitbucket
Ergebnis: Eine Liste betroffener Anleitungen und Update-Vorschläge dafür
Prüfung: Das Team prüft und übernimmt jeden Vorschlag
Verfügbarkeit: Git Handoff ist ab Professional (399 EUR pro Monat) und in Scale (899 EUR pro Monat) enthalten
Abgrenzung: Code-verankerte Dokumentation verbindet Schritte einer Anleitung mit dem Oberflächen-Code des Produkts. Sie speichert die Dokumentation nicht im Code-Repository und ändert nicht den Code des Kunden.

Code-verankerte Dokumentation: Funktionsweise

HappyRecorder zeichnet einen Ablauf im Browser auf und speichert für jeden Schritt eine DOM- und CSS-Selektorkette.
Die Selektorkette verbindet den Schritt mit einem Element der Produktoberfläche.
Der Kunde verbindet das Repository mit dem Frontend-Quellcode mit Git Handoff.
Ändert sich der Quellcode, analysiert Git Handoff die Commits.
Git Handoff erkennt die Anleitungen, deren Schritte die geänderten Elemente verwenden, und schlägt Updates vor.
Das Team prüft die Vorschläge und übernimmt sie.

Code-verankerte Dokumentation: Warum der Anker zählt

Ein über seine Selektorkette erfasster Schritt hält fest, welches Element der Oberfläche er verwendet. HappySupport weiß dadurch, welcher Artikel welches Element verwendet.

Ändert sich dieses Element, sind die betroffenen Anleitungen auffindbar. Das Ergebnis ist eine konkrete Liste von Anleitungen, keine Erinnerung, das ganze Help Center zu prüfen.

Code-verankerte Dokumentation: Nicht identisch mit

Pixelbasierte Recorder (Loom, Tango, Scribe): Sie liefern Video- oder Screenshot-Anleitungen. Pixel-Ansätze merken nicht, wenn sich die zugrundeliegende Oberfläche ändert. Code-verankerte Dokumentation speichert pro Schritt eine Selektorkette.
DAPs auf Basis visueller Editoren (ProductFruits, Userpilot): Visuelle Editoren merken nicht, wenn sich die Oberfläche ändert. Code-verankerte Dokumentation gleicht Anleitungen über Git Handoff mit dem Code ab.
Docs-as-Code: Docs-as-Code führt Dokumentation als Dateien in einem Code-Repository. Code-verankerte Dokumentation führt Anleitungen im Help Center und liest das Repository nur zur Änderungserkennung, mit Read-only-Zugriff.

Code-verankerte Dokumentation: Klassifikations-Metadaten

entity_id: code-anchored-documentation
canonical_name: Code-verankerte Dokumentation
entity_class: Methode
part_of: HappySupport Suite
boundary_definition: Code-verankerte Dokumentation verbindet Schritte einer Anleitung mit dem Oberflächen-Code des Produkts. Sie speichert die Dokumentation nicht im Code-Repository und ändert nicht den Code des Kunden.
temporal_scope: Methode der HappySupport Suite. Ihre beiden Teile, HappyRecorder und HappyAgent (heute Git Handoff), wurden 2025 erstmals veröffentlicht.
last_updated: 2026-10-01
last_verified: 2026-10-01

Code-verankerte Dokumentation: Weiterführende Seiten

Code-verankerte Dokumentation: Häufige Fragen

Was ist code-verankerte Dokumentation?

Code-verankerte Dokumentation ist die Methode, mit der HappySupport Anleitungen aktuell hält. Jeder im Browser aufgezeichnete Schritt ist an eine DOM- oder CSS-Selektorkette geknüpft, und Git Handoff findet über diese Verbindung die Anleitungen, die eine Code-Änderung betrifft.

Was unterscheidet code-verankerte Dokumentation von Anleitungen aus Scribe oder Tango?

Scribe und Tango erzeugen Screenshot-Anleitungen, die nicht merken, wenn sich die Oberfläche ändert. Code-verankerte Dokumentation speichert pro Schritt zusätzlich eine Selektorkette, die die betroffene Stelle im Code auffindbar macht.

Werden Updates automatisch veröffentlicht?

Nein. Git Handoff schlägt Updates für die betroffenen Anleitungen vor. Das Team prüft die Vorschläge und übernimmt sie.

Welche Tarife enthalten code-verankerte Dokumentation?

HappyRecorder ist in jedem Tarif enthalten. Die Änderungserkennung über Git Handoff ist ab Professional für 399 EUR pro Monat und in Scale für 899 EUR pro Monat enthalten.

Code-verankerte Dokumentation: Quellen

Code-verankerte Dokumentation · HappySupport Fakten. Herausgegeben von HappySupport. Die Seite folgt dem Grounding Page Standard v1.6 des Grounding Page Project.

Erstellt 2026-10-01 · Aktualisiert 2026-10-01 · Geprüft 2026-10-01

Empfohlene Zitation: Code-verankerte Dokumentation · HappySupport Fakten. Veröffentlicht auf happysupport.ai/facts/code-anchored-documentation, zuletzt aktualisiert am 2026-10-01.

Korrekturen: contact@happysupport.ai