CodeDoc for Confluence — Dokumentation

Zeige Versionen, Konfigurationswerte, README-Abschnitte und Git-Code auf jeder Confluence-Seite und halte sie aktuell. Optional: Lasse KI vollständige Dokumentationsseiten schreiben.

Schnellstart

  1. Installiere CodeDoc aus dem Atlassian Marketplace (30 Tage kostenlos testen) und öffne Apps → CodeDoc.
  2. Verbinde Git mit einem Token nur für Lesezugriff. Mehr brauchen Synchronisierungsblöcke nicht; die Schnellstartanleitung beschreibt die Token-Einrichtung je Anbieter.
  3. Ergänze die für CodeDoc zugänglichen Repositories unter Repositories .
  4. Bearbeite eine Seite, öffne das Makromenü mit / und wähle CodeDoc Sync Block . Füge einen Dateilink ein, prüfe die Vorschau, speichere und veröffentliche.
  5. Optional: Erstelle eine KI-Seite mit Atlassian AI (Advanced-Edition) oder eigenem KI-Schlüssel.
Auf dieser Seite
  1. Übersicht
  2. Funktionsweise
  3. Installation · Ersteinrichtung · Repositories
  4. Synchronisierungsblöcke: hinzufügen, mögliche Inhalte, Versionsprüfung, Aktualisierungen, Status
  5. KI-Seiten: Stile, Webhook, Dateien, Prüfung
  6. Einstellungen · Anbieter · Editionen · Zugriffskontrolle
  7. Daten und Datenschutz · Fehlerbehebung · Häufige Fragen · Support

Übersicht

CodeDoc hält Confluence-Seiten auf zwei Arten mit deinem Code synchron:

  • Synchronisierungsblöcke: Ein Synchronisierungsblock übernimmt Fakten aus einer Datei auf die Seite, etwa Helm-Chart-Version, YAML-Einstellungen, README-Abschnitt, neuesten CHANGELOG-Eintrag oder Codeausschnitt. Ohne KI und ohne KI-Schlüssel. Mehr erfahren
  • KI-Seiten (optional): KI schreibt vollständige Dokumentationsseiten aus deinem Code, mit Atlassian AI (Advanced-Edition) oder eigenem Anthropic-, OpenAI- oder Google-Gemini-Schlüssel. Mehr erfahren

Die App liest GitHub, GitLab, Bitbucket Cloud, Azure DevOps und eigene GitHub-Enterprise- oder GitLab-Server, auch über mehrere Verbindungen zugleich. Seiten aktualisieren sich bei jedem Push, täglich oder wöchentlich, mit einer Seitenversion je echter Änderung.

CodeDoc-Registerkarte Overview: Synchronisierungsblöcke, letzte Synchronisationsänderung, KI-Seiten, Repositories und jüngste KI-Durchläufe auf einen Blick

Funktionsweise

  1. Git verbinden mit einem Token nur für Lesezugriff. Ein KI-Schlüssel ist optional und später ergänzbar.
  2. Add repositories: Durchsuche dein Git-Konto oder füge eine Repositoryadresse ein.
  3. Synchronisierungsblock hinzufügen: Bearbeite eine Seite, öffne das Makromenü mit / und wähle CodeDoc Sync Block, füge den Dateilink ein und wähle den Inhalt (Synchronisierungsblöcke).
  4. Optional: KI-Seite erstellen: Wähle Repositories, Schreibstil, Zielbereich und Aktualisierungszeitpunkt. CodeDoc veröffentlicht direkt oder als Entwurf zur Prüfung (KI-Seiten).

Beispielausgabe

So sieht eine KI-Seite aus: Aus einem Terraform-Repository erstellte Seiten im Stil Developer Documentation (Entwicklerdokumentation) .

Beispielseiten anzeigen KI-Beispielseite: Übersicht mit Technologietabelle aus Versionen, Rollen und Beschreibungen aus dem Code KI-Beispielseite: Architekturabschnitt mit Grundprinzipien, Komponenteninteraktion und zentralen Modulen KI-Beispielseite: API-Referenz mit Codebeispielen und Abhängigkeitsliste

Andere Stile erzeugen andere Strukturen: Developer Documentation hat 9 Abschnitte einschließlich Architektur, API-Referenz und Fehlerbehebung; Management Overview liefert eine nichttechnische Zusammenfassung mit Risiken und strategischen Empfehlungen.

Installation

  1. Suche CodeDoc im Atlassian Marketplace, klicke auf Try it free (Kostenlos testen) (30 Tage Testphase) und wähle deine Confluence-Cloud-Website.
  2. Öffne in Confluence Apps → CodeDoc. Beim ersten Start erscheint der Einrichtungsassistent.

Ersteinrichtung

Der Einrichtungsassistent hat drei Schritte: Git verbinden (erforderlich), KI-Seiten (optional) und Ready (Bereit). Ein CodeDoc-Administrator führt ihn aus; Confluence-Administratoren sind immer Administratoren.

Einrichtungsassistent: zuerst Git-Anbieter verbinden; der KI-Schritt kann übersprungen werden

Git verbinden

CodeDoc liest nur Dateien. Deshalb genügt ein Token mit read (Lesen) als Berechtigung. Welche Tokens die Anbieter benötigen: Unterstützte Anbieter.

  1. Wähle den Git-Anbieter: GitHub, GitLab, Bitbucket Cloud, Azure DevOps oder dein eigener Server mit GitHub Enterprise oder GitLab self-managed (Details). Ein Hinweis nennt den Token, den du anlegen musst, mit direktem Link. GitHub-Organisationen mit IP-Allowlist wählen stattdessen GitHub App (Schritte).
  2. Trage ein: Zugriffstoken. Bei Azure DevOps trage zusätzlich die Organisations-URL ein (https://dev.azure.com/your-org).
  3. Optional kannst du einen Anzeigenamen festlegen, etwa „GitHub Arbeit“, und auf Connect and continue (Verbinden und fortfahren) klicken. Funktioniert der Token nicht, nennt die Meldung den Grund.

KI-Seiten (optional)

Mit der Advanced-Edition ist Atlassian AI enthalten: Klicke auf Continue with Atlassian AI (Mit Atlassian AI fortfahren). Andernfalls klicke auf Skip, use sync blocks only (Überspringen, nur Synchronisierungsblöcke verwenden) oder Connect an AI provider (KI-Anbieter verbinden) für einen eigenen Schlüssel. Das lässt sich jederzeit ändern unter Settings → Connections (Einstellungen → Verbindungen).

Eigenen KI-Anbieter verbinden
  1. Wähle Anthropic, OpenAI oder Google Gemini und füge deinen API-Schlüssel ein: Anthropic, OpenAI, Google AI Studio.
  2. Klicke auf Connect (Verbinden). CodeDoc prüft den Schlüssel und lädt die vollständige Modellliste des Anbieters.
  3. CodeDoc wählt ein ausgewogenes, schnelles Modell vor. Wähle bei Bedarf ein anderes in der durchsuchbaren Liste Model (Modell) ; Empfehlungen stehen oben.

Schnelle Modelle (Claude Haiku, GPT-mini-Modelle, Gemini Flash) schreiben eine Seite für mittlere Repositories für wenige Cent. Setze im Anbieterkonto ein Ausgabenlimit.

Repositories

Repositories ist der Reiter mit den Repositories, die CodeDoc lesen darf, gruppiert nach der Git-Verbindung, die sie liest. Nur diese stehen für Sync-Blöcke und KI-Seiten zur Verfügung. Nur CodeDoc-Administratoren dürfen sie hinzufügen oder entfernen.

Reiter Repositories: die Repositories nach Git-Verbindung gruppiert, jeweils mit Branch und Datum der Aufnahme
  • Add repositories: Klicke auf der Karte einer Verbindung darauf, oder oben und wähle dann die Verbindung. CodeDoc listet die Repositories, die diese Verbindung lesen kann. Klicke die gewünschten an (sie werden blau markiert; bei langen Listen hilft die Suche) und dann auf Add N repositories.
  • Not listed? Add by address (Nicht in der Liste? Per Adresse): Füge im selben Dialog die Adresse ein, etwa https://github.com/org/repo; auch Datei- oder Branchlinks funktionieren. Lasse Branch leer für den Standardbranch und klicke auf Add repository. CodeDoc prüft zuerst den Zugriff.
  • Remove (Entfernen): neben jedem Repository. Sync-Blöcke und KI-Seiten, die es nutzen, werden nicht mehr aktualisiert, bis es wieder hinzugefügt ist; ihr Inhalt bleibt auf den Seiten.
GitLab-Untergruppen, Bitbucket und eigener Server

Add by address (Per Adresse hinzufügen) funktioniert mit allen Tokentypen und ist die einzige Möglichkeit bei Bitbucket-Zugriffstokens, die keine Repositories auflisten können; dort zeigt der Dialog das Adressfeld gleich. Bei einer Verbindung über Sign in with GitHub, Add repositories führt weiter zur GitHub-Anmeldung, weil GitHub dort bestätigt, dass du in jedem Repository Administrator bist. GitLab-Projekte in Untergruppen (group/subgroup/project) werden unterstützt. Bei eigenem GitHub-Enterprise- oder GitLab-Server verbinde ihn zuerst unter Settings → Connections und füge dann hier Repositories hinzu. Bei Fehlern nennt die Meldung Repository und verwendete Verbindung.

Synchronisierungsblöcke

Ein Synchronisierungsblock zeigt und aktualisiert einen Wert, eine Tabelle, einen Abschnitt oder Code aus einer Repositorydatei auf einer Confluence-Seite. CodeDoc kopiert exakt den Dateiinhalt: keine KI-Aufrufe, kein KI-Schlüssel, keine Tokenkosten.

Runbook-Seite mit Release- und Konfigurationstabellen aus Helm-Chart-Dateien und Codeausschnitt, jeweils durch einen Synchronisierungsblock mit Status In sync aktuell gehalten

Der synchronisierte Text liegt wie getippter Inhalt auf der Seite; Confluence-Suche, PDF-/Word-Export und Seitenverlauf enthalten ihn. CodeDoc schreibt nur bei Git-Änderungen. Bei nicht lesbaren Dateien behält der Block seinen letzten gültigen Inhalt und erklärt den Fehler.

Synchronisierungsblock hinzufügen

  1. Bearbeite eine Seite, öffne das Makromenü mit / und wähle CodeDoc Sync Block.
  2. Füge den Dateilink ein (aus der Adresszeile bei geöffneter Datei im Git-Anbieter) und klicke auf Use link (Link verwenden). CodeDoc setzt Repository, Branch und Pfad. Das Repository muss auf der Registerkarte Repositories vorhanden sein. Oder wähle das Repository und die Datei unter Find a file (Datei suchen) oder Common files (Häufige Dateien).
  3. Wähle den anzuzeigenden Inhalt (Tabelle unten). Statt Schlüsselpfad, Überschrift oder Ausschnittname einzutippen, klicke auf Show the keys of the file (Dateischlüssel anzeigen) (oder Überschriften oder Ausschnitte) und wähle aus der Liste.
  4. Wähle wie oft CodeDoc den Block aktualisiert.
  5. Klicke auf Show preview (Vorschau anzeigen), dann auf Save (Speichern): Der Inhalt erscheint sofort im Editor. Veröffentliche die Seite; ab dann hält CodeDoc den Block aktuell.
Synchronisierungsblock-Einstellungen: GitHub-Link setzt Repository und Pfad, aus der Datei gewählte Schlüsselpfade und Tabellenvorschau

Jedes Feld hat ein (?) mit kurzer Erklärung. Zum späteren Ändern bearbeite die Seite, wähle den Block und klicke auf das Stiftsymbol (Edit).

Mögliche Inhalte eines Synchronisierungsblocks

Anzuzeigender InhaltDeine EingabeBeispiel und Ergebnis
Alle Abhängigkeiten (automatisch)Nur das Repository, optional ein OrdnerJede Abhängigkeit mit ihrer Version, gefunden in package.json, Helm-Charts, Dockerfiles und weiteren Dateien des Repositorys, in einer Tabelle (Details).
Value(s) from YAML or JSON (Werte aus YAML oder JSON) Schlüsselpfad pro Zeile, optional Label = pathimage.tag oder App version = appVersion. Ein Wert erscheint als Text, mehrere als Tabelle.
Regular expression (Regulärer Ausdruck)Ein regulärer Ausdruck; angezeigt wird die erste geklammerte Gruppe^FROM\s+(\S+) zeigt die Basisimages einer Dockerfile.
Markdown section (Markdown-Abschnitt)Die Überschrift ohne #Installation zeigt alles darunter bis zur nächsten Überschrift gleicher Ebene.
Latest CHANGELOG entry (Neuester CHANGELOG-Eintrag)—Der neueste Releaseeintrag samt Überschrift; „Unreleased“ wird übersprungen.
Code snippet between markers (Codeausschnitt zwischen Markierungen)Der AusschnittnameMarkiere den Code mit zwei Markierungskommentaren, etwa # codedoc:start install und # codedoc:end install. Der Block folgt dem Code bei darüber eingefügten Zeilen.
Line range (Zeilenbereich)10-25 oder 42Ein Codeauszug. Werden darüber Zeilen eingefügt, zeigt der Block andere Zeilen; verwende vorzugsweise einen markierten Ausschnitt.
Whole file (Gesamte Datei)—Markdown-Dateien formatiert, andere als Codeblock.
Schlüsselpfadauswahl aus YAML und markierter Codeausschnitt statt manueller Eingabe
Schlüsselpfadsyntax, Ausschnittmarkierungen und Überschriften

Schlüsselpfade: Schlüssel mit Punkten trennen (image.tag), Listeneinträge über Index (containers[0].image), alle Einträge mit * (services.*.image.tag) und Schlüssel mit enthaltenen Punkten in Anführungszeichen (labels["app.kubernetes.io/version"]). Dateien mit mehreren YAML-Dokumenten, etwa Kubernetes-Manifeste, werden dokumentweise durchsucht. Bei fehlendem Schlüsselpfad nennt die Meldung die vorhandenen Schlüssel.

Ausschnittmarkierungen: Neben codedoc:start / codedoc:end funktionieren auch AsciiDoc-Tags (tag::install[] … end::install[]) und [START install] … [END install] . Ausschnitte erscheinen als Code mit Syntaxhervorhebung, Markdown-Dateien formatiert.

Überschriften eine Ebene kleiner: Für Markdown-Inhalte kannst du Make headings one level smaller (Überschriften eine Ebene kleiner machen) aktivieren. Eine Überschrift mit # wird dann Ebene 2 und passt unter die Seitenüberschriften.

Alle Abhängigkeiten, automatisch gefunden

Du musst nicht wissen, wo die Versionen stehen. Wähle das Repository und klicke auf Find all dependencies automatically (oder wähle All dependencies and versions of the repository unter Anzuzeigender Inhalt). CodeDoc durchsucht das Repository und zeigt jede Abhängigkeit mit ihrer Version in einer Tabelle: Komponente, Version wie in der Datei geschrieben und die Datei, aus der sie stammt (verlinkt). Aktiviere Compare with the latest release (Mit neuestem Release vergleichen) , um für npm- und PyPI-Pakete und Docker-Hub-Images die neueste Version und einen Status zu ergänzen.

Einstellungen des CodeDoc-Synchronisierungsblocks: Repository gewählt, All dependencies and versions of the repository ausgewählt, Versionsprüfung aktiviert, Vorschau der Tabelle
Welche Dateien CodeDoc liest
  • JavaScript: package.json (Abhängigkeiten und die Node-Engine; keine devDependencies).
  • Helm und Container: Chart.yaml (Chart, App-Version, Chart-Abhängigkeiten), values*.yaml (Image-Repository und Tag), docker-compose*.yml / compose*.yaml (Service-Images), Dockerfile (Basis-Image jeder Stage).
  • Python: requirements*.txt, pyproject.toml (Abhängigkeiten nach PEP 621, Poetry-Abhängigkeiten, benötigte Python-Version).
  • Go, Java, Terraform: go.mod (direkte Abhängigkeiten und die Go-Version), pom.xml (Abhängigkeiten mit Version, Properties aufgelöst), versions.tf, providers.tf, main.tf, terraform.tf (benötigte Provider und Terraform-Version).
  • Laufzeiten: .nvmrc, .node-version, .python-version, .tool-versions.

Bis zu 25 Dateien, Ordner der obersten Ebene zuerst; node_modules, vendor, Build-Ausgaben und Testdaten werden übersprungen. Gib in großen Repositories einen Folder (Ordner) an (zum Beispiel services/api), um nur aufzulisten, was dort deklariert ist. Die Tabelle zeigt bis zu 200 Abhängigkeiten; ein Hinweis darunter sagt, wenn etwas weggelassen wurde oder nicht gelesen werden konnte.

Feinsteuerung: Dateien, Tiefe und Arten selbst wählen

Öffne Fine-tune (optional) unter der Erklärung. Only these files nimmt einen Pfad pro Zeile; CodeDoc liest dann genau diese Dateien und sucht nicht. Search depth begrenzt die Ordner unterhalb des gewählten Ordners (nur der Ordner selbst, eine oder zwei Ebenen Unterordner). Kinds lässt weg, was die Tabelle nicht zeigen soll, zum Beispiel alles außer Container-Images. Include development dependencies ergänzt die devDependencies aus package.json, markiert mit „dev“. Einstellungen, die du nicht änderst, werden nicht gespeichert. Bleibt nichts zu zeigen, sagt der Block warum, zum Beispiel welche Arten in welchen Dateien nicht gefunden wurden.

Bereich Fine-tune des Abhängigkeits-Blocks: nur diese Dateien, Suchtiefe, Arten und Entwicklungsabhängigkeiten
Eine Confluence-Seite mit den Abhängigkeiten eines Repositorys: Komponente, Version, Datei, neueste Version und Status

Compare with the latest release (Mit neuestem Release vergleichen)

Aktiviere für eine Dateiversion, etwa Imagetag oder Paketversion, Compare with the latest release (Mit neuestem Release vergleichen) (Arten „Value(s)“ und „Regular expression“). Der Block zeigt das neueste veröffentlichte Release daneben samt farbigem Status; Tabellen erhalten die Spalten Latest release (Neuestes Release) und Status.

StatusBedeutung
Up to date (Aktuell) (grün)Die Datei verwendet das neueste Release.
Newer than latest (Neuer als latest) (blau)Die Dateiversion liegt über dem von der Registry als latest bezeichneten Release, etwa eine Vorabversion.
Update available (Aktualisierung verfügbar) (gelb)Ein neueres Neben- oder Korrekturrelease ist verfügbar.
Major update (Neue Hauptversion) (gelb)Eine neuere Hauptversion ist verfügbar.
End of life (Supportende) (rot)Die Versionslinie erhält keine Aktualisierungen mehr (laut endoflife.date, für Produkte wie nginx, PostgreSQL, Redis, Node.js, Python, Ubuntu und Alpine). Während des Supports nennt der Block das Enddatum.
Not checked (Nicht geprüft) (grau)CodeDoc konnte den Wert nicht zuordnen, er ist keine Version oder die Registry hat nicht geantwortet. Der Grund steht daneben.
Versionsprüfung auf einer Seite: package.json-Abhängigkeiten mit Spalten Latest release und Status
Suchquellen und übertragene Daten

Suchquelle: Automatically (Automatisch) erkennt Imagereferenzen (nginx:1.25.3 oder ein Helm-Wert image.tag neben image.repository), Abhängigkeiten in package.json und name==version in den Zeilen von requirements.txt. Wähle für andere Werte Quelle und Name: Docker-Hub-Image, npm- oder PyPI-Paket, Releases eines GitHub-Projekts (owner/repository) oder Produkt auf endoflife.date.

Images werden mit Tags desselben Formats verglichen: 1.25.3-alpine mit dem neuesten x.y.z-alpine, 20-alpine mit dem neuesten NN-alpine. Vorabversionen werden ausgelassen. Images außerhalb von Docker Hub (ghcr.io, quay.io, private Registrys) werden noch nicht geprüft.

Datenschutz: Nur der öffentliche Image- oder Paketname (etwa nginx oder react) wird an die öffentliche Registry gesendet, nie Datei oder Repository, und nur bei aktivierter Prüfung. Für GitHub-Releases enthält die Anfrage auch deinen verbundenen github.com-Token, der nur das Anfragelimit erhöht. Aktiviere dies nicht für interne Paketnamen. Antworten bleiben 12 Stunden gespeichert; ein Prüfdatum wird nicht angezeigt, damit sich die Seite nur bei geänderter Antwort ändert. Blöcke mit „On every push“ werden bei aktivierter Prüfung auch täglich ausgeführt, da neue Releases ohne Push erscheinen.

Aktualisierungsregeln

HäufigkeitVerhalten
Daily (Täglich) oder Weekly (Wöchentlich)CodeDoc prüft die Datei täglich oder wöchentlich und ändert die Seite nur bei geändertem Inhalt.
On every push to the branch (Bei jedem Push auf den Branch)Der Block aktualisiert sich sofort nach einem Push. Dafür muss der Webhook von CodeDoc im Repository eingerichtet sein (Webhook-Einrichtung); eine Webhook-URL bedient KI-Seiten und Synchronisierungsblöcke.
Only manually (Nur manuell)Der Block ändert sich nur beim Klick auf Update now (Jetzt aktualisieren).

Unabhängig von der Regel darf ein Job Operator auf Update now (Jetzt aktualisieren) am Block oder unter Sync blocks klicken. Ohne Änderungen meldet der Block dies und die Seite bleibt unverändert.

Wer Synchronisierungsblöcke einrichten darf

Nur Nutzer mit der Rolle Job Operator oder Administrator (Rollen) dürfen die Inhaltsquelle eines Blocks wählen. Seitenbearbeiter ohne CodeDoc-Rolle können keine Repositorydateien auf die Seite übernehmen.

So funktioniert die Freigabe
  • Im Blockdialog gespeicherte Einstellungen gelten als freigegeben: Nach Veröffentlichung der Seite beginnt die Synchronisierung beim ersten Aufruf.
  • Anderweitig auf die Seite gelangte Einstellungen (mit Seite oder Vorlage kopiert, per API geschrieben oder später geändert) zeigen Waiting for approval (Warten auf Freigabe) , bis ein Job Operator mit Seitenbearbeitungsrechten Repository, Datei, Branch, Inhalt, Aktualisierungsregel und Versionsprüfung prüft und anschließend Approve and sync (Freigeben und synchronisieren) anklickt.
  • Ein Block liest nur Dateien seines verbundenen Repositories. Pfade und Branches, die ../ enthalten (auch geschrieben als %2e%2e), Rückstrichen oder Steuerzeichen werden abgelehnt (Settings incomplete (Einstellungen unvollständig) mit Erklärung).
  • Zugriffstokens bleiben in CodeDoc. Die auf der Seite gespeicherten Blockeinstellungen enthalten nur Repository, Pfad und Optionen.
  • Live-Dokumente öffnen im Editor, deshalb zeigt der Block seinen Status direkt dort, und ein Job Operator mit Seitenbearbeitungsrechten gibt ihn frei, indem er Approve and sync (Freigeben und synchronisieren) anklickt. Aktualisierungen erscheinen im offenen Dokument, während du arbeitest; was du tippst, bleibt erhalten.

Status und Meldungen

Unter jedem Block nennt eine Statuszeile App (CodeDoc Sync Block), Zustand und letzte Prüfung. Job Operators sehen außerdem Update now (Jetzt aktualisieren) und Manage (Verwalten) zum Öffnen von CodeDoc. Beim Darüberfahren erscheinen Details wie die Quelldatei.

StatusBedeutungAbhilfe
In sync (Synchron)Der Block ist aktuell.Nichts erforderlich.
Update failed (Aktualisierung fehlgeschlagen)Die letzte Aktualisierung scheiterte, etwa nach Dateiumbenennung oder Tokenablauf. Der letzte gültige Inhalt bleibt erhalten.Befolge den Hinweis „What to do“ und klicke anschließend auf Update now (Jetzt aktualisieren).
Settings incomplete (Einstellungen unvollständig)Pflichteinstellungen fehlen; die Meldung listet sie auf.Bearbeite die Seite, wähle den Block und klicke auf das Stiftsymbol.
Waiting for approval (Warten auf Freigabe)Neue oder geänderte Einstellungen sind noch nicht freigegeben.Ein Job Operator mit Seitenbearbeitungsrechten öffnet den Block einmal.
Detached (Nicht mehr verbunden)Der Block wurde entfernt oder seine Seite gelöscht beziehungsweise in den Papierkorb verschoben. CodeDoc schreibt nie in Seiten im Papierkorb.Remove detached (Nicht mehr verbundene Einträge entfernen) auf der Registerkarte Sync blocks.
Not synced (license) (Nicht synchronisiert, Lizenz)Ohne aktive Lizenz werden 3 Synchronisierungsblöcke aktuell gehalten; dieser wäre ein weiterer.Entferne einen unnötigen Block oder hole CodeDoc im Atlassian Marketplace.
Blockmeldung: CodeDoc Sync Block settings incomplete mit fehlendem Dateipfad und Schlüsselpfad samt Anleitung

Alle Synchronisierungsblöcke verwalten

Synchronisierungsblöcke : Diese Registerkarte listet alle Blöcke mit Seite, Quelle, Inhaltsart, Aktualisierungsregel, Status, letzter Prüfung und gegebenenfalls Abhilfe. Filtere mit Needs attention (Handlungsbedarf), starte einen Block über Update now (Jetzt aktualisieren) oder stoppe die Synchronisierung mit Remove (Entfernen) (der Block bleibt mit seinem letzten Inhalt auf der Seite und synchronisiert erst wieder, wenn ein Job Operator ihn dort freigibt). Remove detached (Nicht mehr verbundene Einträge entfernen) löscht Einträge nicht mehr vorhandener Seiten oder Blöcke.

Registerkarte Sync blocks mit allen Blöcken, Seite, Quelle, Art, Aktualisierungsregel, Status und letzter Prüfung

Gut zu wissen

Grenzen und Verhalten der Synchronisierungsblöcke
  • Dateien bis 1 MB. Ausschnitte, Zeilenbereiche und vollständige Dateien werden bis 20.000 Zeichen angezeigt; Markdown-Abschnitte haben keine Zeichengrenze, nur die 1-MB-Dateigrenze. Bis zu 20 Schlüsselpfade oder 50 Tabellenzeilen pro Block, reguläre Ausdrücke bis 200 Zeichen.
  • Änderungen innerhalb eines Blocks werden bei der nächsten Aktualisierung ersetzt. Schreibe eigenen Text darüber oder darunter.
  • Jede echte Aktualisierung erstellt eine Seitenversion; Confluence benachrichtigt Seitenbeobachter wie bei anderen Änderungen.
  • Relative Markdown-Links führen zur Datei im Git-Anbieter; Bilder erscheinen als Links, da Confluence Bilder privater Repositories nicht laden kann. Die Quellenzeile unter jedem Block verlinkt die Datei.
  • Ohne aktive Lizenz bleiben 3 Synchronisierungsblöcke aktuell; zuvor freigegebene Blöcke laufen weiter (Editionen).
  • In einem Live-Dokument beginnt ein gerade eingefügter Block mit den Aktualisierungen, sobald Confluence die Bearbeitungssitzung gespeichert hat; bis dahin weist der Block darauf hin. CodeDoc prüft zwei Stunden lang alle 10 Minuten erneut, danach mit der nächsten Aktualisierung oder Update now (Jetzt aktualisieren).

KI-Seiten (optional)

Eine KI-Seite (in früheren Versionen Job genannt) definiert Inhalt, Schreibstil und Veröffentlichungsziel. Sie benötigt Atlassian AI (Advanced-Edition) oder einen verbundenen KI-Anbieter (Settings → Connections (Einstellungen → Verbindungen)).

KI-Seiten : Dieser Bereich hat drei Unterregisterkarten: Pages (Seiten) (Run, Edit, Copy, Delete — Ausführen, Bearbeiten, Kopieren, Löschen), Durchläufe und Schreibstile. New AI page (Neue KI-Seite) öffnet einen Editor mit vier Schritten:

  1. Quelle: Seitenname, bis zu zwei Repositories mit Branch und Ordner sowie die von der KI gelesenen Dateien (Dateiauswahl).
  2. Content (Inhalt): Schreibstil, Sprache und maximale Seitenlänge; optional beginnen mit einem gespeicherten Stil.
  3. Target page (Zielseite): Bereich, übergeordnete Seite und Prüfung jedes Durchlaufs (Prüfung und Rückgängig machen).
  4. Aktualisierungen: manuell, bei jedem Push oder nach Zeitplan, mit Zusammenfassung der CodeDoc-Aktionen.
Neue KI-Seite, Schritt Source mit den von der KI gelesenen Dateien; daneben Auswahl zwischen Atlassian AI und eigenem KI-Anbieter
KI-Seite bearbeiten oder kopieren

Next (Weiter) nennt noch fehlende Angaben eines Schritts. Edit (Bearbeiten) ändert eine bestehende KI-Seite: Go to step (Zum Schritt) springt zum gewünschten Bereich und Save changes (Änderungen speichern) funktioniert aus jedem Schritt (die Seite selbst ändert sich beim nächsten Durchlauf). Copy (Kopieren) erstellt eine neue KI-Seite mit denselben Einstellungen einschließlich Zielbereich.

Schreibstile

Der Schreibstil legt Struktur, Ton und Detailtiefe für die Zielgruppe fest.

StilFürErgebnis
Developer Documentation (Entwicklerdokumentation)EntwicklerCodebeispiele, Architektur, API-Referenz, Konfiguration und Fehlerbehebung. 9 Abschnitte.
Comprehensive Technical (Umfassende technische Dokumentation)EntwicklerAlle Module, Datenmodelle, Sicherheit, Buildpipeline, Teststrategie und bekannte Einschränkungen. 12 Abschnitte.
Management Overview (Managementübersicht)Beteiligte und EntscheiderFunktionen, Risiken, Skalierbarkeit und Empfehlungen ohne Fachjargon oder Code.
Customer Documentation (Kundendokumentation)Externe KundenFunktionen, Einstieg und Integration ohne interne Details.
Compliance & Audit (Compliance und Prüfung)Sicherheit, ComplianceSicherheitskontrollen, Datenklassifizierung, Zugriffsverwaltung, Zuordnungen zu DSGVO/ISO 27001/SOC 2 und Risikoregister.
Onboarding Guide (Einarbeitungsanleitung)Neue TeammitgliederEinrichtung, Grundkonzepte, tägliche Abläufe und häufige Fehler.
Quick Reference (Kurzreferenz)EntwicklerTechnologien, wichtige Befehle, Projektstruktur und zentrale Konfigurationswerte. 5 Abschnitte.
Custom (Eigener Stil)BeliebigDeine eigenen Anweisungen (bis zu 2.000 Zeichen).
Neue KI-Seite: Schritt Content mit Schreibstil, Sprache und Seitenlänge sowie Schritt Updates mit täglichem Zeitplan und Zusammenfassung

Ausführungszeitpunkt einer KI-Seite

Schritt 4 legt die Ausführung fest. Alle drei Optionen funktionieren in jeder Edition und ohne aktive Lizenz („On every push“ benötigt das Webhook-Geheimnis).

AktualisierungsregelFunktionsweise
Manually (Manuell)Klicke auf Run (Ausführen) auf der KI-Seite.
On every push (Bei jedem Push)Startet nach einem Push auf den konfigurierten Branch. Benötigt den Webhook (unten).
On a schedule (Nach Zeitplan)Startet täglich, wöchentlich oder monatlich. Alle Zeiten sind UTC.

Webhook-Einrichtung

Webhook-URL bedient alle KI-Seiten und Synchronisierungsblöcke mit „On every push“. Kopiere sie aus Settings → Webhook (Einstellungen → Webhook) und ergänze sie als Webhook in jedem Repository. CodeDoc ordnet Ereignisse über Repositoryadresse und Branch KI-Seiten und Blöcken zu; dieselbe URL funktioniert überall. Jeder Webhook braucht das Webhook-Geheimnis aus Settings → Webhook (Einstellungen → Webhook) (Create secret (Geheimnis erstellen)): Ohne es verarbeitet CodeDoc keine Webhook-Aufrufe.

Push-Ereignisse genügen überall, da auch ein Merge in den Branch ein Push ist. CodeDoc akzeptiert außerdem die unten genannten Merge-Ereignisse; andere Ereignisse (etwa GitHub issues oder Bitbucket repo:fork) werden ignoriert.

AnbieterVerwendete EreignisseAktualisierter Branch
GitHubNur Push-Ereignisse (push). Pull-Request-Ereignisse werden ignoriert; ein zusammengeführter Pull Request kommt als Push an.Der Branch des Pushs
GitLabPush-Ereignisse (Push Hook) und Merge-Request-Ereignisse (Merge Request Hook; jedes zählt, auch Öffnen oder Aktualisieren)Push: Branch des Pushs. Merge Request: Zielbranch
BitbucketPush (repo:push) und Zusammenführung eines Pull Requests (pullrequest:fulfilled)Push: Branch des Pushs. Zusammengeführter Pull Request: Zielbranch
Azure DevOpsCode pushed (git.push) und Zusammenführung eines Pull Requests (git.pullrequest.merged)Push: Branch des Pushs. Zusammengeführter Pull Request: Zielbranch
GitHub: Webhook hinzufügen
  1. Repository → Einstellungen → Webhooks → Add webhook (Webhook hinzufügen).
  2. Trage ein: Webhook-URL in „Payload URL“. Setze Content type (Inhaltstyp) auf application/json. Hinterlege das Webhook-Geheimnis aus CodeDoc (Settings → Webhook) unter Secret (Geheimnis).
  3. Wähle Just the push event (Nur Push-Ereignisse) und klicke dann auf Add webhook (Webhook hinzufügen).
GitLab: Webhook hinzufügen
  1. Project (Projekt) → Einstellungen → Webhooks.
  2. Trage ein: Webhook-URL. Hinterlege das Webhook-Geheimnis aus CodeDoc (Settings → Webhook) unter Secret token (Geheimnistoken).
  3. Aktiviere unter „Trigger“ Push events (Push-Ereignisse) und klicke dann auf Add webhook (Webhook hinzufügen).
Bitbucket: Webhook hinzufügen
  1. Repository → Repository settings (Repositoryeinstellungen) → Webhooks → Add webhook (Webhook hinzufügen).
  2. Gib einen Titel ein (etwa „CodeDoc“) und trage ein: Webhook-URL. Hinterlege das Webhook-Geheimnis aus CodeDoc (Settings → Webhook) unter Secret (Geheimnis).
  3. Wähle unter „Triggers“ Repository → Push (repo:push) und klicke auf Save (Speichern).
Azure DevOps: Service Hook hinzufügen
  1. Project settings (Projekteinstellungen) → Service hooks → Create subscription (Abonnement erstellen) → Web Hooks.
  2. Wähle das auslösende Ereignis Code pushed.
  3. Trage ein: Webhook-URL. Wähle Basic authentication (Basisauthentifizierung): beliebiger Nutzername, das Webhook-Geheimnis aus CodeDoc (Settings → Webhook) als Passwort. Klicke auf Finish (Fertigstellen).

Auf eigenen GitHub-Enterprise- oder GitLab-Servern sind die Schritte gleich; der Server muss die Webhook-Adresse im Internet erreichen können.

Geplante Aktualisierungen

Ein Zeitplan schreibt die Seite regelmäßig neu, ohne Webhook. Wähle in Schritt 4 Daily (Täglich) (früheste Stunde, 0–23 UTC), Weekly (Wöchentlich) (Wochentag und Stunde) oder Monthly (Monatlich) (Tag 1–28 und Stunde). Aktiviere Write the page once right after saving (Direkt nach dem Speichern einmal erstellen) für eine sofortige erste Version.

Zeitpunkt: Atlassian prüft Zeitpläne stündlich, deshalb startet ein Durchlauf innerhalb etwa einer Stunde nach der eingestellten Zeit. „Daily 02:00 UTC“ läuft zwischen 02:00 und etwa 03:00 UTC.

Dateiauswahl

In Schritt 1 liest CodeDoc die Dateiliste gewählter Repositories und Ordner und zeigt drei Zahlen: die gefundenen Codedateien, die Anzahl der pro Durchlauf gelesenen Dateien und die geschätzte KI-Eingabe in Tokens im Vergleich zur Grenze unter Settings → AI limits. Bei Atlassian AI erscheint auch der maximale Creditverbrauch pro Durchlauf.

Schritt Source: KI-Dateiauswahl mit Zahlen und Auswahl zwischen Automatik und fester Liste
  • Automatically (recommended) (Automatisch, empfohlen): Bis zu 30 Codedateien werden vollständig gelesen. Bei mehr Dateien wählt dein KI-Anbieter pro Durchlauf die wichtigsten bis zur Dateigrenze, einschließlich neuer Dateien; dafür ist ein kleiner zusätzlicher KI-Aufruf nötig.
  • From my file list (Aus meiner Dateiliste): Jeder Durchlauf liest genau deine ausgewählten Dateien. CodeDoc beginnt mit den wichtigsten (Einstiegspunkte, Konfiguration, READMEs); Suggest files with AI (Dateien mit KI vorschlagen) lässt deinen KI-Anbieter eine Liste vorschlagen. Neue Dateien werden nicht automatisch ergänzt.

Um ein Modul eines großen Repositories zu dokumentieren, trage dessen Folder (Ordner) in Schritt 1 ein.

„Too large for one page“ (Zu groß für eine Seite)

Eine Seite wird aus höchstens 50 Dateien (in Settings anpassbar) innerhalb etwa 120.000 Tokens erstellt. Bei mehr als 1.500 Codedateien im gewählten Umfang oder über 10.000 Repositorydateien meldet Schritt 1 „Too large for one page“ (Zu groß für eine Seite) mit Zahlen und nächsten Schritten. Ein trotzdem gestarteter Durchlauf stoppt direkt nach Lesen der Dateiliste vor jedem KI-Aufruf; keine Tokens werden verbraucht. Grenze mit dem Feld Folder (Ordner) ein (ein Modul oder Dienst pro KI-Seite), wähle From my file list (Aus meiner Dateiliste) (dann werden unabhängig von der Repositorygröße nur markierte Dateien gelesen) oder halte einzelne Fakten aktuell mit einem Synchronisierungsblock.

Die Dateiliste wird pro Editorsitzung einmal gelesen; Zurückspringen oder Rückkehr zu einem früheren Ordner fragt Git nicht erneut ab. Dateien anzeigen / Choose files (Dateien auswählen) öffnet die Liste mit Filterfeld; lange Listen zeigen die ersten 60 Dateien und Show all (Alle anzeigen). Nach Ordnerwechsel fallen außerhalb liegende Dateien aus deiner Auswahl.

Dateifilter (erweitert)

Klappe Dateifilter (erweitert) unten im Dateibereich auf, um die Liste mit Glob-Mustern zu verfeinern, eines pro Zeile:

  • Leave out (Auslassen): passende Dateien werden entfernt, zum Beispiel **/*.test.ts, **/__tests__/**, **/migrations/**.
  • Keep anyway (Trotzdem behalten): behält von einem Leave-out-Muster ausgeschlossene Dateien, etwa **/api.test.ts. Es ist keine Positivliste: Passt eine Datei zu keinem Feld, bleibt sie immer enthalten. Für ein einzelnes Verzeichnis verwende das Feld Folder (Ordner) .

**/ benötigt mindestens einen Ordner vor dem Namen. Ergänze deshalb auch *.test.ts , um Testdateien im Repository-Hauptverzeichnis auszuschließen. Bei leeren Feldern gelten die Standards: Buildausgaben, Sperrdateien, minimierte und Binärdateien werden gefiltert; typische Zugangsdaten-Dateien, zum Beispiel .env oder private Schlüssel, werden nie gelesen.

Maximale Seitenlänge

Wähle in Schritt 2 Short (Kurz) (etwa 5–7 Seiten), Standard (etwa 10–15 Seiten, empfohlen) oder Long (Lang) (etwa 20–30 Seiten). Das ist eine Obergrenze, kein Ziel: Die KI stoppt bei vollständigem Inhalt. Bei abruptem Ende wähle länger. Optionen jenseits der Modellkapazität fehlen (etwa Long bei gpt-4o-mini). Administratoren können stattdessen die genaue Anzahl Ausgabetokens aktivieren: Settings → AI limits → Advanced: exact page length in tokens (Erweitert: genaue Seitenlänge in Tokens).

Confluence-Ziel

Jede KI-Seite veröffentlicht in einen Confluence-Bereich, optional unter einer übergeordneten Seite („Root (no parent)“ erstellt auf oberster Ebene). Weitere Durchläufe aktualisieren dieselbe Seite ohne Duplikate.

Titelkonflikte

Confluence-Seitentitel sind pro Bereich eindeutig. Beim Speichern prüft CodeDoc den Bereich; bei Konflikten warnt Schritt 3. Benenne die KI-Seite um oder klicke auf Save anyway (Trotzdem speichern). Die KI-Seite zeigt dann den Hinweis ⚠ Title conflict (Titelkonflikt) und Run (Ausführen) fragt zuerst nach Bestätigung.

Prüfung und Rückgängig machen

Aktiviere Review each run before it is published (Jeden Durchlauf vor Veröffentlichung prüfen) in Schritt 3. Jeder Durchlauf erstellt dann einen Entwurf [DRAFT] <Seitenname> am selben Ort; die KI-Seite zeigt In review (In Prüfung). Die veröffentlichte Seite bleibt bis zur Entwurfsveröffentlichung unverändert. Der Entwurf ist eine normale Seite: Alle mit Bereichszugriff können ihn sehen.

  • Open draft (Entwurf öffnen): Lies oder bearbeite ihn in Confluence.
  • Publish (Veröffentlichen): Die veröffentlichte Seite erhält den Entwurfsinhalt (beim ersten Mal wird der Entwurf selbst zur Seite). Die vorherige Version bleibt im Verlauf.
  • Discard (Verwerfen): Nach Bestätigung landet der Entwurf im Bereichspapierkorb; die veröffentlichte Seite bleibt unverändert.

Letzten Durchlauf rückgängig machen

Hat ein Durchlauf direkt oder über Entwurfsveröffentlichung eine bestehende Seite aktualisiert, bietet die KI-Seite Undo last run (Letzten Durchlauf rückgängig machen). CodeDoc stellt die vorherige Fassung als neue Version wieder her; die KI-Fassung bleibt im Verlauf. Der Durchlauf zeigt Undone (Rückgängig gemacht).

Details zu Prüfung und Rückgängig machen
  • Bei Änderungen nach dem Durchlauf stellt CodeDoc nicht zurück, damit keine Bearbeitungen verloren gehen. Stattdessen nennt es die wiederherstellbare Verlaufsfassung. Bei einer neu erstellten Seite gibt es keine Vorversion; lösche sie in Confluence.
  • Ein verworfener Entwurf lässt sich aus dem Bereichspapierkorb wiederherstellen. Verweigert Confluence die Löschung, nennt die Meldung Grund und Abhilfe; der Entwurf bleibt für einen neuen Versuch verknüpft.
  • Bei erneutem Durchlauf mit wartendem Entwurf landet der alte im Papierkorb und ein neuer wird erstellt. Wartende Entwürfe erscheinen auch unter Needs attention (Handlungsbedarf) in der Übersicht.
  • Ein nach Prüfung veröffentlichter Durchlauf zeigt Published (Veröffentlicht) im Verlauf; ein Klick zeigt veröffentlichende Person und Zeitpunkt.

Gespeicherte Schreibstile

Ein gespeicherter Stil legt Inhaltseinstellungen als benannte Vorlage ab. Erstelle ihn einmal unter AI pages → Writing styles (KI-Seiten → Schreibstile) und starte neue KI-Seiten damit über Start from a saved style (Mit gespeichertem Stil beginnen) in Schritt 2.

Registerkarte Writing styles mit gespeichertem Stil, Basisstil, Sprache und Erstellungsdatum
Gespeicherte Einstellungen und Änderungsrechte
  • Dokumentationstyp (einer der 8 Stile oder Custom (Eigener Stil) mit eigenen Anweisungen; dein Text ist die vollständige Anweisung), Ausgabesprache, maximale Seitenlänge und Ausschlussmuster.
  • Nur Administratoren dürfen Stile erstellen, bearbeiten, kopieren oder löschen (+ New style (Neuer Stil), Edit (Bearbeiten), Copy (Kopieren), Delete (Löschen)); alle mit Zugriff dürfen sie verwenden.
  • Ein gespeicherter Stil füllt alle passenden Felder zugleich aus; sie bleiben einzeln anpassbar. Direkt in eine KI-Seite eingegebene eigene Anweisungen gelten nur für diese Seite.

Registerkarte Übersicht

CodeDocs erste Ansicht. Bis Repository und Synchronisierungsblock vorhanden sind, zeigt sie die ersten Schritte. Danach:

  • Auf einen Blick: Blöcke und Anzahl mit Handlungsbedarf, letzte Seitenänderung eines Blocks, KI-Seiten und Repositories.
  • Needs attention (Handlungsbedarf): fehlgeschlagene Blöcke, wartende Freigaben, KI-Entwürfe zur Prüfung, fehlgeschlagene KI-Seiten, fast aufgebrauchtes KI-Kontingent und zu ersetzende Bitbucket-Verbindungen, jeweils mit passender Schaltfläche.
  • Letzte KI-Durchläufe: die letzten fünf mit Ergebnis, Modell und Seitenlink.

Durchläufe (KI-Seiten)

AI pages → Runs (KI-Seiten → Durchläufe) protokolliert Zeitpunkt und Wirkung aller Durchläufe. Angezeigt werden die Anzahlen der letzten 30 Tage, Running now (Aktuell laufend) mit Fortschritt und Cancel (Abbrechen) sowie der Run history (Durchlaufverlauf).

Registerkarte Runs: Anzahlen der letzten 30 Tage und Verlauf mit Zeit, KI-Seite, Ergebnis, Modell, gelesenen Dateien und Tokens
Inhalt des Durchlaufverlaufs
  • Jeder Durchlauf, neuester zuerst: Zeit, KI-Seite, Ergebnis (Published (Veröffentlicht), In review (In Prüfung), Discarded (Verworfen), Undone (Rückgängig gemacht), Failed (Fehlgeschlagen)), KI-Anbieter und Modell, gelesene Dateien (etwa „42 of 128“ mit Auswahlmethode), Tokens und Seitenlink. Klicke auf Failed (Fehlgeschlagen) für Grund und Abhilfe.
  • Nächste geplante Durchläufe: Bei geplanten KI-Seiten nächster Durchlauf mit Countdown und letzter Durchlauf.
  • Durchläufe pro Zeitraum: erfolgreiche Durchläufe je Tag, Woche oder Monat.
  • Clear history (Verlauf löschen) (Administratoren) entfernt alle Durchlaufdatensätze; Confluence-Seiten bleiben unverändert.

Einstellungen

Einstellungen : Hier gibt es fünf Registerkarten: Connections (Verbindungen), Webhook, AI limits (KI-Grenzen), Berechtigungen (Administratoren) und Privacy & help (Datenschutz und Hilfe). Nur Administratoren dürfen Einstellungen ändern; Job Operators dürfen sie sehen.

Settings, Connections: Git-Verbindung mit Token nur für Lesezugriff und KI-Karte mit Atlassian AI oder eigenem KI-Anbieter

Git-Verbindungen

Verbinde mehrere Anbieter oder Konten gleichzeitig, etwa Arbeits-GitHub, GitLab-Gruppe und eigenen GitLab-Server. Jede Verbindung zeigt Anbieter, Name, Nutzer, Hinzufügungsdatum und Anzahl zugehöriger Repositories; eigene Server tragen die Kennzeichnung Own server (Eigener Server), die eigene GitHub App deiner Organisation mit GitHub App.

Verbindungen hinzufügen und entfernen

Add connection (Verbindung hinzufügen) öffnet dasselbe Formular wie bei der Einrichtung. Remove (Entfernen) löscht den gespeicherten Token (bzw. den Schlüssel der GitHub App) und die Repositories dieser Verbindung; die letzte Verbindung lässt sich nicht entfernen. Wird die letzte Verbindung zu einem eigenen Server entfernt, wird auch seine Freigabe zurückgenommen (Atlassian bittet einen Site-Admin um Bestätigung).

KI für KI-Seiten

KI ist optional und nur für KI-Seiten nötig. Die Karte zeigt deine Edition. Mit Advanced (Erweitert) wählst du den Ersteller der Seiten: Atlassian AI (enthalten, ohne Schlüssel; Modell Balanced (Ausgewogen) oder Fast (Schnell) mit Kontingentanzeige) oder deinen eigenen KI-Anbieter (Kontingent).

Für deinen eigenen Anbieter prüft Connect AI provider (KI-Anbieter verbinden) (oder Change provider or key (Anbieter oder Schlüssel ändern)) einen Schlüssel und lädt die Modelle. Turn AI off (KI ausschalten) (Standard) oder Remove own key (Eigenen Schlüssel entfernen) (Advanced) löscht den gespeicherten Schlüssel. Blöcke funktionieren weiter und KI-Seiten bleiben erhalten; mit Advanced laufen sie mit Atlassian AI weiter.

Die Modellliste Durchsuchbare Modellliste: zuerst Empfehlungen, danach alle Textmodelle des Anbieters
  • Model (Modell) : Die Liste enthält alle Textmodelle deines Anbieters, neueste zuerst, mit Recommended (Empfohlen) oben (etwa neueste Sonnet-, Haiku- und Opus-Modelle, GPT und GPT mini, Gemini Pro und Flash). Suche per Eingabe.
  • Refresh list (Liste aktualisieren) lädt seit der Verbindung veröffentlichte Modelle. Audio-, Bild-, Embedding- und andere Nichttextmodelle werden ausgelassen.
  • Bei nicht mehr angebotenem Modell erscheint eine Warnung. Wähle ein anderes, sonst scheitern KI-Seiten mit „model not available“.

Webhook

Zeigt die gemeinsame Webhook-URL für KI-Seiten und Blöcke mit „On every push“, mit kurzen Anleitungen je Git-Anbieter (Webhook-Einrichtung). Ohne Webhook verwende tägliche oder wöchentliche Aktualisierung.

Settings, Webhook: unkenntlich gemachte Webhook-Adresse, Einrichtungsschritte je Git-Anbieter und Karte für das Webhook-Geheimnis

Webhook-Geheimnis (Administratoren): Create secret (Geheimnis erstellen) erstellt ein zufälliges Geheimnis. Es ist erforderlich: CodeDoc nimmt Aufrufe nur mit Geheimnis an, damit niemand sonst über die Adresse Aktualisierungen oder KI-Durchläufe mit deinem KI-Budget auslöst. Ergänze es bei jedem Webhook an CodeDoc. Ohne Geheimnis zeigt die Karte Secret missing (Geheimnis fehlt) und CodeDoc lehnt alle Webhook-Aufrufe ab. „On every push“ lässt sich erst mit vorhandenem Geheimnis speichern.

Weitere Informationen zum Geheimnis

Show secret (Geheimnis anzeigen) und Replace secret (Geheimnis ersetzen) stehen daneben; Entfernen ist nicht möglich. Nach Ersatz aktualisiere es in allen Git-Webhooks. URL und Geheimnis sind für alle Anbieter gleich: GitHub und GitHub Enterprise verwenden das Webhook-Feld Secret (Geheimnis), GitLab Secret token (Geheimnistoken), Bitbucket Secret (Geheimnis), Azure DevOps Basic authentication (Basisauthentifizierung) mit dem Geheimnis als Passwort. Ein Push bei noch wartender KI-Seite startet keinen zweiten Durchlauf; der wartende liest ohnehin den neuesten Commit.

AI limits (KI-Grenzen)

  • Maximale Dateien pro KI-Seite: Standard 50 (Bereich 5–200). Größere Ordner werden auf die wichtigsten Dateien eingegrenzt.
  • Budget für Eingabetokens: gesamter Code pro KI-Durchlauf, Standard 120.000 (Bereich 30.000–500.000). Bleibe unter dem Kontextfenster deines Modells.

Zu große Repositories (mehr als 1.500 Codedateien oder insgesamt 10.000 Dateien) stoppen vor KI-Aufrufen mit Hinweisen zu nächsten Schritten. Blöcke sind von diesen Grenzen nicht betroffen.

Settings, AI limits: maximale Dateianzahl pro KI-Seite und Eingabetokenbudget

Unterstützte Anbieter

KI-Anbieter

AnbieterModelleHinweise
AnthropicClaude Opus, Sonnet, HaikuVollständige Modellliste deines Kontos, Empfehlungen zuerst.
OpenAIGPT und GPT miniNur Textmodelle deines Kontos.
Google AIGemini Pro und FlashKostenloser Tarif für erste Tests (Google kann dessen Daten zur Produktverbesserung nutzen).
Atlassian AI (Advanced)Claude Sonnet (Balanced), neuestes Claude Haiku (Fast)Ohne eigenen Schlüssel; auf Atlassians Plattform mit monatlichem Kontingent (unten).

Git-Anbieter

CodeDoc liest nur. Die Schnellstartanleitung enthält schrittweise Token-Anleitungen je Anbieter.

AnbieterToken
GitHub (github.com), mit AnmeldungKein Token: bei GitHub anmelden und die Repositories wählen. Ein Owner der Organisation installiert die CodeDoc GitHub App einmal; sie kann nur lesen (Schritte).
GitHub (github.com)Fine-grained token mit Contents: Read oder klassischer Token mit dem repo als Berechtigungsbereich. GitHub-Dokumentation
GitHub Enterprise (dein Server oder NAME.ghe.com)Dieselben Tokens, auf deinem Server erstellt. Ein Website-Administrator gibt die Adresse einmal frei (Details).
GitHub App (die eigene App deiner Organisation auf github.com)Kein Token: App-ID und privater Schlüssel einer App, die deine Organisation anlegt, mit Contents: Read. Für Organisationen mit IP-Allowlist oder ohne persönliche Tokens (Schritte).
GitLab (gitlab.com)Persönlicher, Gruppen- oder Projektzugriffstoken mit read_api + read_repository. GitLab-Dokumentation
GitLab self-managed (dein Server, auch unter einem Pfad)Dieselben Tokens, auf deinem Server erstellt. Ein Website-Administrator gibt die Adresse einmal frei.
Bitbucket Cloud (bitbucket.org)Repository-, Projekt- oder Workspace-Zugriffstoken mit Repositories: Read. Keine persönlichen API-Tokens (Begründung). Bitbucket-Dokumentation
Azure DevOps (dev.azure.com)Persönlicher Zugriffstoken mit Code (Read); die Organisations-URL ist erforderlich. Microsoft-Dokumentation

Dein eigener Git-Server

CodeDoc liest GitHub Enterprise Server, GitHub Enterprise Cloud with data residency (NAME.ghe.com) und GitLab self-managed (auch unter einem Pfad wie https://example.com/gitlab) genauso wie github.com und gitlab.com.

  1. Settings → Connections → Add connection (Verbindung hinzufügen): Wähle GitHub Enterprise oder GitLab self-managed und gib die Adresse ein, über die du den Server öffnest.
  2. Klicke auf Allow access to the server (Serverzugriff erlauben): Atlassian bittet einen Website-Administrator um Bestätigung von CodeDoc-Anfragen an diese Adresse. Ohne Freigabe blockiert Forge jede Anfrage.
  3. Gib einen Servertoken nur für Lesezugriff ein und klicke auf Connect (Verbinden). Direkt nach neuer Freigabe braucht Atlassian etwas Zeit; das Formular versucht es automatisch erneut.
Settings, Git connections: Formular für GitLab self-managed mit Serveradresse und Allow access to the server
Netzwerk und Freigabedetails

CodeDoc läuft in Atlassians Cloud, nicht in deinem Netzwerk. Der Server muss über HTTPS aus dem Internet erreichbar sein, mit Zertifikat einer öffentlichen Zertifizierungsstelle. Bei Firewall erlaube Atlassians ausgehende IP-Adressen (IP-Adressen und Domains für Atlassian-Cloud-Produkte).

Die Freigabe steht unter Atlassian Administration → Connected apps → CodeDoc → Data management („Data storage, sharing, receiving and processing“), wo Administratoren sie entfernen können. Repositories, Dateilinks, Blöcke, KI-Seiten und Webhooks funktionieren danach wie bei Cloud-Diensten.

GitHub: mit einer Anmeldung verbinden

Der schnellste Weg, github.com zu verbinden: Du meldest dich bei GitHub an und wählst, was CodeDoc lesen darf. Kein Token, kein Schlüssel. Dahinter steht die CodeDoc GitHub App, die ein Owner deiner GitHub-Organisation einmal installiert, für alle Repositories oder nur für einige. Sie kann nur lesen.

Wer verbinden kann: ein GitHub-Konto mit Admin-Recht am Repository (Owner der Organisation haben es für jedes Repository). Das ist dieselbe Schwelle, die GitHub selbst verlangt, um einer App Zugriff auf ein Repository zu geben. Kannst du ein Repository nur lesen, bitte einen Repository-Admin oder einen Owner der Organisation, es zu verbinden; das dauert eine Minute und braucht kein Token.

  1. In CodeDoc: Settings → Connections → Add connection (Verbindung hinzufügen) → GitHub. Sign in with GitHub ist der empfohlene Weg und schon ausgewählt. CodeDoc, Add connection: GitHub gewählt, der Weg „Sign in with GitHub“ als empfohlen markiert
  2. Bei GitHub anmelden: Klicke auf Sign in to GitHub. Im selben Tab öffnet sich eine Seite von Atlassian; klicke auf Continue, melde dich bei GitHub an, falls GitHub danach fragt, und klicke auf Authorize. Du landest wieder in CodeDoc, und das Fenster öffnet sich dort, wo du warst. CodeDoc erfährt, welche Organisationen und Repositories dein GitHub-Konto lesen kann, sonst nichts. Zustimmungsseite von Atlassian für die GitHub-Anmeldung, mit ContinueGitHub-Seite zum Autorisieren von CodeDoc for Confluence, mit CodeDoc-Logo und dem Knopf Authorize
  3. App installieren, einmal pro Organisation: Steht deine Organisation noch nicht in der Liste, klicke auf Install the CodeDoc app on GitHub. Ein Owner der Organisation wählt All repositories oder Only select repositories und klickt auf Install; die Seite bestätigt Read access to code and metadata. Bist du kein Owner, schickt GitHub den Ownern stattdessen eine Anfrage. CodeDoc bemerkt die Installation von selbst.
  4. Repositories wählen: Bei einer Organisation geht CodeDoc direkt zu deren Repositories weiter; bei mehreren klickst du auf Choose repositories neben der richtigen. Die Liste zeigt die Repositories dieser Organisation, bei denen du Admin bist. Wurde die App nur für ausgewählte Repositories installiert, sind sie schon ausgewählt. Klicke auf Connect (Verbinden). CodeDoc-Anmeldefenster, Schritt 3: Repositories der Organisation wählen
  5. Fertig: Die Repositories stehen sofort in CodeDoc (Reiter Repositories), und die Verbindung erscheint mit Sign-in via the CodeDoc app. Sync-Blöcke und KI-Seiten lesen daraus wie aus jeder anderen Verbindung. CodeDoc, Git-Verbindungen: die neue Verbindung mit „Sign-in via the CodeDoc app“

Später mehr Repositories: Repositories → Add repositories auf der Karte dieser Verbindung → Continue with GitHub sign-in, dann auf Add repositories neben der Organisation. Weniger: Entferne ein Repository im Reiter Repositories; CodeDoc kann es danach nicht mehr lesen. Anderes GitHub-Konto: Klicke auf Use another GitHub account und folge den drei Schritten, die es zeigt.

Was CodeDoc lesen kann und wer das entscheidet

Drei Grenzen gelten zusammen, und GitHub setzt jede davon durch:

  • Der Owner der Organisation entscheidet, für welche Repositories die App installiert ist (alle oder ausgewählte), und kann das jederzeit unter Organisationseinstellungen → GitHub Apps → Configure ändern oder die App entfernen.
  • Wer verbindet, muss bei GitHub Admin jedes Repositorys sein. Der Zugriff bleibt an diese Rolle gebunden: Endet sie, etwa weil die Person die Organisation verlässt, liest CodeDoc das Repository nicht mehr und zeigt Needs confirmation an der Verbindung, bis ein aktueller Admin es bestätigt (Add connection → GitHub → Add repositories). Die Seiten behalten so lange ihren letzten Inhalt.
  • Der CodeDoc-Administrator kann nur Repositories hinzufügen, die sein eigenes GitHub-Konto verwaltet. CodeDoc fordert bei GitHub einen Token an, der auf genau die Repositories der Verbindung begrenzt ist, auch wenn die App für mehr installiert ist.
  • Nur lesen: Die App hat die Berechtigungen Contents: Read-only und Metadata: Read-only, sonst keine. Der Token gilt eine Stunde und wird danach neu angefordert.

Deine GitHub-Anmeldung liegt bei Atlassian, nicht bei CodeDoc, und wird nur gebraucht, während du verbindest oder Repositories hinzufügst. Danach liest CodeDoc über die App; die Verbindung funktioniert also weiter, wenn die Person, die sie eingerichtet hat, das Unternehmen verlässt. Du kannst die Anmeldung unter Atlassian-Konto → Verbundene Apps.

Ein Repository, das die Organisation bei GitHub aus der App herausnimmt, fällt von selbst aus der Verbindung; die anderen Repositories laufen weiter.

Organisationen mit IP-Allowlist

Ein Schritt bei GitHub, durch einen Owner der Organisation: Organisationseinstellungen → Authentication security → Enable IP allow list configuration for installed GitHub Apps ankreuzen. Die CodeDoc-App bringt die ausgehenden Adressen von Atlassian mit; niemand muss sie eintragen. Ohne das Kästchen erreicht CodeDoc die Organisation nicht und nennt dir diesen Schritt.

Bei einer solchen Organisation lehnt GitHub Anfragen ab, die in deinem Namen aus der Atlassian-Cloud kommen. CodeDoc fragt GitHub deshalb über die App, bei welchen Repositories der App dein GitHub-Konto Admin ist, und bietet nur diese an. Ist die App für mehr als 100 Repositories installiert, gibst du die Repositories stattdessen mit Namen ein (OWNER/NAME), und CodeDoc prüft jedes auf dieselbe Weise.

Wann stattdessen ein Token oder eine eigene GitHub App
  • GitHub Enterprise Server oder NAME.ghe.com: Die CodeDoc-App gibt es nur auf github.com. Verbinde mit einem Token (eigener Git-Server).
  • Deine Organisation lässt keine fremden Apps zu: Erstelle eine eigene GitHub App.
  • Ein einzelnes persönliches Repository: Ein Fine-grained Token mit Contents: Read funktioniert wie bisher.

GitHub App: Organisationen mit IP-Allowlist

Wenn deine GitHub-Organisation nur Anfragen von den Adressen auf ihrer IP allow list annimmt oder keine persönlichen Zugriffstokens erlaubt, verbinde CodeDoc über eine GitHub App, die deiner Organisation gehört. GitHub lässt eine Organisation die Adressen einer App nur für diese App zu; bei Tokens öffnet ein Eintrag auf der Liste sie für jede Anfrage von diesen Adressen.

  1. In CodeDoc: Settings → Connections → Add connection (Verbindung hinzufügen) → GitHub App, und gib den Namen deiner Organisation ein. Das Formular zeigt die Schritte unten und verlinkt direkt auf die richtigen Seiten bei GitHub. CodeDoc, Add connection, GitHub App: Name der Organisation, die vier Schritte bei GitHub, App-ID und privater Schlüssel
  2. App anlegen (ein Owner der Organisation): Klicke auf open the pre-filled form on GitHub. Name, Beschreibung und Homepage sind ausgefüllt. Unter Berechtigungen sind nur Contents: Read-only und das verpflichtende Metadata gesetzt, der Webhook ist aus, und die App lässt sich nur in deiner Organisation installieren (Only on this account). Klicke auf Create GitHub App. GitHub, Create GitHub App: Name, Beschreibung und Homepage-URL bereits ausgefüllt GitHub, Create GitHub App: ein Repository-Recht gewählt, nur in diesem Konto installierbar, Knopf Create GitHub App
  3. App-ID notieren und Schlüssel erzeugen: Die Seite General der App zeigt die App-ID. Öffne dann Credentials → Key pairs → New key; GitHub lädt eine .pem -Datei herunter. GitHub, die Seite General der neuen App mit der App-ID (hier unscharf) und dem Menü Credentials GitHub, App-Einstellungen, Credentials, Key pairs: Knopf New key
  4. App installieren: Install App → Install neben deiner Organisation. Wähle All repositories oder Only select repositories; die Seite bestätigt Read access to code and metadata. Klicke auf Install. GitHub, App-Einstellungen, Install App: Knopf Install neben der Organisation GitHub, Install: alle Repositories oder ausgewählte, mit Lesezugriff auf Code und Metadaten
  5. Nur mit IP-Allowlist, vor dem Verbinden: Ergänze auf der Seite General der App ganz unten unter IP allow list, ergänze Muster unter die ausgehenden IPv4-Bereiche von Atlassian, je einen Eintrag (die Liste). Aktiviere dann in den Einstellungen der Organisation unter Settings → Authentication security das Häkchen Enable IP allow list configuration for installed GitHub Apps und klicke auf Save (Speichern). Die Liste der Organisation zeigt die Einträge jetzt als Managed by the … GitHub App; sie gelten nur für Anfragen dieser App. GitHub, IP-Allowlist der App mit den ausgehenden IPv4-Bereichen von Atlassian GitHub, Einstellungen der Organisation, IP-Allowlist: Enable IP allow list configuration for installed GitHub Apps ist aktiviert, Einträge von der App verwaltet
  6. In CodeDoc verbinden: Füge die App-ID und den gesamten Inhalt der .pem -Datei ein und klicke auf Connect (Verbinden). Ohne Schritt 5 antwortet CodeDoc mit „Nothing is saved yet“ und nennt die fehlenden Schritte. Die Verbindung erscheint dann mit der Markierung GitHub App. CodeDoc, Git connections: die neue Verbindung mit der Markierung GitHub App
  7. Verwenden: Repositories → Add repositories auf der Karte der Verbindung → Repositories anklicken → hinzufügen. Synchronisierungsblöcke und KI-Seiten lesen darüber wie über jede andere Verbindung. Eine Confluence-Seite mit einem CodeDoc-Synchronisierungsblock, der Image und Version aus einem privaten Repository zeigt, In sync
Wie CodeDoc den Schlüssel der App aufbewahrt

App-ID, Installation und privater Schlüssel werden verschlüsselt in deiner Confluence-Site gespeichert (Forge Secret Storage) und nie wieder angezeigt. Für jeden Lesevorgang signiert CodeDoc mit dem Schlüssel eine kurzlebige Anfrage und erhält von GitHub einen Token, der eine Stunde gilt und nur Repository-Inhalte und Metadaten lesen darf. CodeDoc nutzt nur die Installation in der Organisation, der die App gehört, prüft bei jedem Token, dass die Installation noch zu dieser Organisation gehört, und verwendet keinen Token mit mehr als Lesezugriff. Kein Schlüssel wird zwischen Kunden geteilt: Jede Confluence-Site hat ihre eigene App.

Um den Schlüssel zu ersetzen, erzeuge bei GitHub einen neuen, verbinde dieselbe App in CodeDoc erneut (die Repositories bleiben) und lösche dann den alten Schlüssel bei GitHub.

Welche Adressen auf die IP-Allowlist der App gehören

Die IPv4-Bereiche, die unter „Outgoing connections for Atlassian apps“ auf der Atlassian-Seite stehen; GitHubs API wird über IPv4 erreicht. Stand Oktober 2026 passen sie in 13 Einträge: 104.192.136.0/21, 185.166.140.0/22, 131.162.88.0/21, 13.52.5.96/28, 13.200.41.224/28, 13.236.8.224/28, 16.63.53.224/28, 18.136.214.96/28, 18.184.99.224/28, 18.234.32.224/28, 18.246.31.224/28, 43.202.69.96/28, 52.215.192.224/28. Prüfe die Atlassian-Seite auf Änderungen.

Bitbucket-Tokens

CodeDoc liest Bitbucket Cloud mit einem Zugriffstoken: Ein Repository-Zugriffstoken (Repository settings → Access tokens, „Repositories: Read“, alle Tarife) oder mit Bitbucket Premium einem Projekt- oder Workspace-Zugriffstoken für mehrere Repositories. Bei Repository-Tokens füge je Repository eine Verbindung hinzu.

Warum persönliche API-Tokens und App-Passwörter nicht akzeptiert werden

Atlassians Sicherheitsanforderungen für Marketplace-Apps verbieten das Sammeln und Speichern von Atlassian-Kontozugangsdaten; Bitbucket-API-Tokens gehören einem Atlassian-Konto. Zugriffstokens gehören dagegen Repository, Projekt oder Workspace. Vor CodeDoc 8 mit persönlichem Token erstellte Verbindungen laufen zunächst weiter und sind zum Ersatz markiert. Ergänze eine Zugriffstoken-Verbindung und entferne die alte.

Editionen, Testphase und Lizenz

CodeDoc ist eine kostenpflichtige App mit zwei Editionen und einer 30-tägigen kostenlosen Testphase. Beide enthalten Sync-Blöcke und KI-Seiten; Advanced (Erweitert) ergänzt Atlassian-gehostete KI, sodass KI-Seiten keinen eigenen Schlüssel brauchen.

FunktionStandardAdvanced (Erweitert)
Synchronisierungsblöcke: Werte, Abschnitte, Änderungsprotokolle, Ausschnitte, Dateien, Versionsprüfung✓✓
GitHub, GitLab, Bitbucket Cloud, Azure DevOps und eigene GitHub-Enterprise- oder GitLab-Server✓✓
KI-Seiten mit eigenem Anthropic-, OpenAI- oder Google-Gemini-Schlüssel✓✓
Prüfung vor Veröffentlichung, Rückgängig machen, Zeitpläne, Webhooks, Rollen✓✓
Atlassian AI: KI-Seiten ohne eigenen Schlüssel, Claude-Modelle auf Atlassians Plattform—✓
Monatliches KI-Kontingent mit Verbrauchsanzeige (100 Credits pro Monat)—✓

Atlassian AI und monatliches Kontingent

  • Atlassian AI erstellt KI-Seiten mit Claude-Modellen auf Atlassians Plattform (Forge LLMs) und derselben Inhaltsmoderation wie Atlassians KI-Funktionen. Wähle unter Settings → Connections Balanced (Ausgewogen) (Claude Sonnet, ausführlichste Seiten) oder Fast (Schnell) (neuestes von Atlassian angebotenes Claude Haiku, etwa ein Drittel der Credits). Die Dateiauswahl großer Repositories verwendet immer das schnelle Modell.
  • Jede Website erhält 100 Credits pro Monat; die Advanced-Testphase hat 100 für die gesamte Dauer. Eine typische Balanced-Seite braucht 2–5 Credits, eine kleine deutlich unter einem. Der Editor zeigt den maximalen Verbrauch („up to N credits per run“).
  • Vor dem Start prüft CodeDoc, ob der maximal mögliche Verbrauch noch passt. Andernfalls startet nichts; die Meldung nennt die Rücksetzung am ersten Tag des nächsten Monats (UTC). Bis dahin können KI-Seiten einen eigenen Anbieter nutzen. Die 100 Testcredits werden nicht zurückgesetzt; nach Verbrauch nutze für den Rest der Testphase einen eigenen Anbieter.
  • Settings zeigt verbrauchte und verbleibende Credits, Durchläufe und Monatstokens; Overview warnt ab 80 %. CodeDoc-Credits sind von Rovo getrennt: Keine Belastung deiner Atlassian-AI-/Rovo-Kontingente und keine Zusatzgebühr.
CodeDoc Advanced: Atlassian AI mit monatlicher Kontingentanzeige und Auswahl eines eigenen KI-Anbieters

Ein vor dem Wechsel zu Advanced verbundener eigener Anbieter bleibt aktiv, bis ein Administrator Atlassian AI auswählt.

Trial (Testphase)

Während der 30-tägigen Testphase sind alle Editionsfunktionen verfügbar, mit unbegrenzten Blöcken, Repositories, KI-Seiten und Durchläufen. Advanced enthält dabei Atlassian AI mit 100 Credits für die gesamte Testphase; danach 100 Credits monatlich.

Ohne aktive Lizenz (nach der Testphase)

  • 3 Synchronisierungsblöcke bleiben aktuell. Früher freigegebene Blöcke laufen weiter; neue über der Grenze zeigen „Not synced (license)“ und behalten ihren Inhalt.
  • 1 KI-Seite kann mit eigenem KI-Anbieter eingerichtet werden. Früher eingerichtete KI-Seiten funktionieren weiter mit allen Regeln (manuell, Webhook, Zeitplan).
  • Unbegrenzte Repositories; alle Schreibstile, Sprachen und eigenen KI-Anbieter bleiben verfügbar. Atlassian AI benötigt eine aktive Advanced-Lizenz oder Testphase.

Zugriffskontrolle

Confluence-Administratoren haben immer vollen Zugriff. Andere erhalten ihn über Confluence-Gruppen, die du einer von zwei Rollen zuweist.

Rollen

RolleFürBefugnisse
AdministratorApp-Administratoren, TeamleiterAlles: Overview (Übersicht), Sync blocks (Synchronisierungsblöcke), AI pages (KI-Seiten), Repositories und Settings (Einstellungen) einschließlich Permissions (Berechtigungen).
Job OperatorEntwickler, DokumentationsverantwortlicheOverview (Übersicht), Sync blocks (Synchronisierungsblöcke einrichten, freigeben, aktualisieren), AI pages (KI-Seiten erstellen und ausführen); Repositories und Settings (Einstellungen) schreibgeschützt.
Confluence-AdministratorWebsite- und ProduktadministratorenImmer voller Administratorzugriff; keine Gruppe nötig.
Keine RolleAlle anderen NutzerEin Hinweis, dass CodeDoc für sie noch nicht freigegeben ist, mit der Bitte, einen Confluence-Administrator zu fragen, und einem Link zu dieser Anleitung.

Konfiguration

  1. Öffne CodeDoc → Settings → Permissions (Einstellungen → Berechtigungen) (nur Administratoren).
  2. Unter Administrator Groups (Administratorgruppen) und Job Operator Groups (Job-Operator-Gruppen) suche eine Confluence-Gruppe und klicke auf + Add (Hinzufügen).
  3. Verwalte die Gruppenmitglieder unter Confluence Settings → Groups; die App braucht bei Ein- oder Austritten keine Änderungen.
Settings, Permissions: Administratorgruppen und Job-Operator-Gruppen
Tipps und Verzögerungen

Erstelle zwei eigene Gruppen, beispielsweise codeDocAI-Admins und codeDocAI-JobOperator, um CodeDoc-Zugriff getrennt und leicht prüfbar zu halten. Deine Rolle steht oben rechts in der App.

Neue Gruppenmitglieder erhalten innerhalb etwa 2 Minuten Zugriff; entfernte verlieren ihn innerhalb etwa 30 Minuten. Eine erzwungene Aktualisierung ist nicht möglich, um Confluence-API-Aufrufe gering zu halten.

Datenverarbeitung und Datenschutz

Alle Verarbeitung läuft auf Atlassians Forge-Infrastruktur; es gibt keinen CodeDoc-Server.

  • Synchronisierungsblöcke: Die Forge-Laufzeit liest die gewählte Datei mit deinem Token beim Git-Anbieter und CodeDoc schreibt den ausgewählten Teil in den Block. Nichts geht an KI-Anbieter. CodeDoc speichert Blockeinstellungen und Inhaltsprüfsumme, nicht die Datei.
  • Versionsprüfung (optional): Nur bei aktivierter Prüfung wird der öffentliche Image- oder Paketname (etwa nginx) an die öffentliche Registry gesendet: Docker Hub, npm, PyPI, GitHub-Releases oder endoflife.date. Antworten liegen 12 Stunden im App-Speicher deiner Website. Weder Dateiinhalt noch Repository werden gesendet; GitHub-Releases-Anfragen enthalten den verbundenen github.com-Token.
  • KI-Seiten (optional): Die Forge-Laufzeit lädt gewählte Dateien mit deinem Token; typische Zugangsdaten-Dateien wie .env oder private Schlüssel werden nie geladen. Bei eigenem KI-Anbieter werden Dateien mit deinem API-Schlüssel unter deinem Konto und dessen Datenbedingungen gesendet. Bei Atlassian AI (Advanced) gehen sie an Claude-Modelle auf Atlassians Plattform, ohne externes KI-Konto oder Schlüssel. CodeDoc speichert Dateinamen, Tokenanzahlen und Atlassian-AI-Credits je Durchlauf, nicht den Code.
Eigener KI-Anbieter: Bei eigenen Anbietern geht Quellcode auch an sie und unterliegt deren Verarbeitungs- und Aufbewahrungsregeln. Prüfe die Bedingungen vor Übertragung sensiblen Codes. Bei Atlassian AI bleibt Code auf Atlassians Plattform.
Speicherung, Verschlüsselung, Seitenänderungen und Nutzungsstatistik
  • Alle Übertragungen sind verschlüsselt mit TLS.
  • CodeDoc ruft nur deine Git-Anbieter (einschließlich freigegebener eigener Server), für KI-Seiten deinen KI-Anbieter oder Atlassian AI und bei Versionsprüfung die oben genannten öffentlichen Registrys auf.
  • API-Schlüssel und Zugriffstokens liegen im verschlüsselten Forge-Speicher deiner Confluence-Website. Sie werden nie erneut angezeigt, auf Seiten geschrieben oder protokolliert.
  • CodeDoc erstellt und aktualisiert Seiten als CodeDoc-App: KI-Seiten in gewählten Bereichen, Blöcke nur innerhalb ihres Blocks. Seitenbeschränkungen gegen die App stoppen diese Aktualisierungen.
  • Nutzungsstatistik: CodeDoc zählt Funktionsaufrufe (etwa „Synchronisierungsblock aktualisiert“) websiteübergreifend und schreibt technische Logs, die Atlassian App-Anbietern bereitstellt. Die Zähler enthalten keine Seiten-, Bereichs-, Repository-, Datei- oder Nutzerinformationen.

Vollständige Details: Datenschutzerklärung.

Fehlerbehebung

Die meisten CodeDoc-Meldungen nennen Ursache und Abhilfe. Hilft das nicht, schreibe an support@janekbehrens.de.

Synchronisierungsblöcke

„the file or the branch does not exist (HTTP 404)“ (Datei oder Branch existiert nicht)

Prüfe den Dateipfad und den Branch in den Blockeinstellungen: Pfade beachten Groß- und Kleinschreibung und beginnen unterhalb des Repository-Hauptverzeichnisses. Kopiere den Pfad beim Git-Anbieter (Teil nach dem Branchnamen). Aktualisiere ihn nach Umbenennung oder Verschiebung. Show preview (Vorschau anzeigen) prüft den Pfad vor dem Speichern.

„Key path … was not found in the file“ (Schlüsselpfad nicht gefunden)

Die Meldung nennt vorhandene Schlüssel an dieser Stelle, beispielsweise Keys under „image“: repository, pullPolicy, tag. (Schlüssel unter „image“) Schlüsselpfade beachten Groß- und Kleinschreibung und funktionieren nur mit YAML und JSON. Für andere Dateien wähle regulären Ausdruck, Zeilenbereich oder vollständige Datei.

„Settings incomplete“ oder „Waiting for approval“ (Einstellungen unvollständig oder Freigabe ausstehend)

Settings incomplete (Einstellungen unvollständig) listet fehlende Einstellungen auf: Bearbeite die Seite, wähle den Block und klicke auf das Stiftsymbol. Waiting for approval (Warten auf Freigabe) bedeutet, dass neue oder geänderte Einstellungen noch nicht freigegeben sind. Ein Job Operator oder Administrator mit Seitenbearbeitungsrechten muss den Block einmal öffnen (Details).

„the Git provider rejected the access token (HTTP 401)“ (Git-Anbieter lehnt Zugriffstoken ab)

Der gespeicherte Token ist ungültig oder abgelaufen. Austauschen lässt er sich nicht direkt: Ein Administrator legt unter Settings → Connections (Einstellungen → Verbindungen) eine Verbindung mit einem neuen Token an, entfernt die alte und fügt ihre Repositories über die neue wieder hinzu (das Entfernen einer Verbindung entfernt auch ihre Repositories; Sync-Blöcke finden ihres am Namen wieder, KI-Seiten brauchen es neu ausgewählt). Auf github.com braucht Sign in with GitHub gar keinen Token. Bis zur nächsten erfolgreichen Aktualisierung bleibt der letzte gültige Blockinhalt erhalten.

„the GitHub organization accepts requests only from addresses on its IP allow list (HTTP 403)“ (GitHub-Organisation akzeptiert nur Adressen ihrer IP-Allowlist)

Deine GitHub-Organisation akzeptiert nur Anfragen von den Adressen auf ihrer IP-Allowlist, und CodeDoc liest deine Repositories aus Atlassians Cloud. Zwei Wege, beide erledigt ein Owner der Organisation: eine GitHub App deiner Organisation verbinden (Schritte), deren Einträge in der IP-Allowlist nur für diese App gelten; oder Atlassians ausgehende IP-Bereiche (IPv4 und IPv6) zur Liste der Organisation hinzufügen unter Settings → Authentication security → IP allow list, und der Token bleibt, wie er ist. Diese Bereiche teilt sich Atlassians gesamte Cloud; GitHub verlangt weiterhin für jede Anfrage deinen Zugriffstoken. Schon mit einer GitHub App verbunden? Dann fehlt die IP-Allowlist der App oder das Häkchen „Enable IP allow list configuration for installed GitHub Apps“.

„On every push“ aktualisiert nicht

Push-Aktualisierungen benötigen den CodeDoc-Webhook mit Geheimnis im Repository (Webhook-Einrichtung) und einen Push auf den Branch des Blocks (Einstellung Branch oder Standardbranch des Repositories). Update now (Jetzt aktualisieren) prüft den Block zwischenzeitlich.

KI-Seiten

„A Confluence page named … already exists in this space“ (Seitentitel bereits vorhanden)

Seitentitel sind je Bereich eindeutig. Benenne die KI-Seite um oder benenne beziehungsweise verschiebe die andere Confluence-Seite. CodeDoc warnt beim Speichern vor Konflikten (Confluence-Ziel).

„AI returned empty response“ (Leere KI-Antwort)
  • Eingabetokenbudget zu niedrig: Erhöhe es unter Settings → AI limits.
  • Seitenlänge zu kurz: Erhöhe die Einstellung Maximale Seitenlänge in Schritt 2.
  • Modellgrenzen: Teste ein leistungsfähigeres Modell (etwa Haiku → Sonnet oder GPT mini → vollständiges GPT-Modell).
XHTML-Verarbeitungsfehler

KI-Ausgaben sind manchmal kein gültiges Confluence-Markup. CodeDoc repariert Tags und Makros automatisch; schlägt das fehl, nutzt es ein vereinfachtes Format (Klartext mit Überschriften), sodass die Seite immer entsteht. Starte die KI-Seite erneut.

„Rate limit exceeded“ (429) (Anfragelimit überschritten)

Dein KI-Anbieter begrenzt Anfragen. CodeDoc versucht es bis zu 3-mal mit steigenden Wartezeiten (3, 8, 15 Sekunden). Bei anhaltendem Fehler warte einige Minuten, prüfe Tarifgrenzen und reduziere die gelesene Dateianzahl.

„Insufficient credits/balance“ oder Kontingentmeldung des Anbieters

Dein KI-Konto hat kein Guthaben. Lade es auf bei Anthropic oder OpenAI; prüfe bei Gemini das Kontingent in AI Studio.

Der Anbieter meldet eine zu große Anfrage

Der Code überschreitet die maximale Modelleingabe. Lasse CodeDoc Dateien automatisch wählen oder markiere weniger, reduziere das Eingabetokenbudget, ergänze Muster unter Leave out (Auslassen) oder setze einen Folder (Ordner) (Dateiauswahl) oder wechsle zu einem Modell mit größerem Kontextfenster.

Atlassian AI: „the included AI allowance for this month is used up“ (Monatliches Kontingent aufgebraucht)

Der Durchlauf startete nicht und verbrauchte nichts. Das Kontingent erneuert sich am ersten Tag des nächsten Monats (UTC). Wähle bis dahin Your own AI provider (Eigener KI-Anbieter) unter Settings → Connections oder warte. Bei kleinem Rest können weniger Dateien oder kürzere Seiten noch passen.

Atlassian AI: „declined this request in its content safety check“ (Anfrage bei Inhaltsprüfung abgelehnt)

Atlassian prüft jede Anfrage wie bei eigenen KI-Funktionen. Lasse ungewöhnliche Inhalte aus (AI page → Source → file filters) oder verwende für diese Seite einen eigenen Anbieter.

Eine geplante KI-Seite lief nicht zum erwarteten Zeitpunkt

Zeitpläne werden stündlich geprüft; Durchläufe starten bis etwa eine Stunde nach der eingestellten Zeit. Prüfe nach 2 Stunden ohne Durchlauf die Aktualisierungsregel On a schedule (Nach Zeitplan), den korrekten Eintrag Nächste geplante Durchläufe unter AI pages → Runs und die Gültigkeit von Git-Token sowie gegebenenfalls eigenem KI-Schlüssel.

Die Seite ist zu kurz oder ungenau

Erhöhe die Einstellung Maximale Seitenlänge, ergänze wichtigere Dateien (die KI kann nur erhaltenen Code dokumentieren, also Konfiguration, README und package.json) oder teste ein leistungsfähigeres Modell. KI-Seiten können Fehler enthalten; prüfe sie vor dem Teilen und erwäge Review each run before it is published (Jeden Durchlauf vor Veröffentlichung prüfen).

Webhooks, Verbindungen und Server

Webhook: „Event is not supported“ (Ereignis nicht unterstützt)

Der Webhook sendet ein ungenutztes Ereignis. Sende Push- oder unterstützte Merge-Ereignisse aus der Ereignistabelle; fork, issue, comment und andere werden ignoriert.

Webhook kommt an, aber nichts aktualisiert sich

Keine KI-Seite oder kein Block passt. Prüfe, ob das Repository auf der Registerkarte Repositories mit derselben Adresse wie im Webhook steht, ob der Push auf den konfigurierten Branch erfolgt und ob die Aktualisierungsregel lautet: On every push (Bei jedem Push).

Bitbucket: „personal API tokens and app passwords cannot be used“ (Persönliche API-Tokens und App-Passwörter nicht verwendbar)

CodeDoc akzeptiert nur Bitbucket-Zugriffstokens (Bitbucket-Tokens). Erstelle einen Repository-Zugriffstoken mit „Repositories: Read“ und füge nur den Tokenwert ein.

Bitbucket: „Add repositories“ zeigt keine Liste

Bitbucket erlaubt Zugriffstokens keine Repositoryauflistung (die kontoweite Liste wurde 2026 entfernt). Unter Repositories → Add repositories fragt der Dialog deshalb nach der Adresse jedes Repositorys; dort prüft CodeDoc den Lesezugriff. Mit Bitbucket Premium deckt ein Projekt- oder Workspace-Token mehrere Repositories ab.

Eigener Server: „CodeDoc may not connect to … yet“ oder „could not reach …“ (Verbindung noch nicht erlaubt oder Server nicht erreichbar)
  • Verbindung noch nicht erlaubt: Klicke auf Allow access to the server (Serverzugriff erlauben); ein Website-Administrator bestätigt Atlassians Dialog. Warte direkt nach Freigabe eine Minute und klicke erneut auf Connect (Verbinden) .
  • Nicht erreichbar: Atlassians Cloud kann die Adresse nicht öffnen. Prüfe HTTPS mit öffentlichem Zertifikat und Firewallfreigabe für Atlassians ausgehende IP-Adressen.
  • Erreichbar, aber Token abgelehnt: Token falsch, abgelaufen oder ohne Leseberechtigung (GitHub: Contents read; GitLab: read_api und read_repository).

Häufige Fragen

Verwenden Synchronisierungsblöcke KI oder kosten sie Tokens?

Nein. Ein Synchronisierungsblock kopiert exakt den Dateiinhalt: keine KI-Aufrufe, keine Tokenkosten, keine Übertragung an KI-Anbieter.

Findet die Confluence-Suche den Inhalt eines Synchronisierungsblocks?

Ja. Der synchronisierte Inhalt wird wie normaler Text auf der Seite gespeichert und ist in Confluence-Suche, PDF-/Word-Export und Seitenverlauf enthalten.

Überfüllen Synchronisierungsblöcke den Seitenverlauf?

Nein. CodeDoc schreibt nur bei geändertem Git-Inhalt auf die Seite; jede Seitenversion entspricht einer echten Dateiänderung.

Verbraucht CodeDoc unsere Rovo- oder Atlassian-AI-Kontingente?

Nein. Atlassian AI in CodeDoc Advanced hat ein eigenes monatliches Kontingent im Abonnement. Deine Rovo- und Atlassian-AI-Kontingente bleiben unberührt.

Kann CodeDoc GitLab oder GitHub Enterprise hinter einer Firewall lesen?

Nur bei Erreichbarkeit aus Atlassians Cloud: CodeDoc läuft auf Forge, nicht in deinem Netzwerk. Erlaube Atlassians ausgehende IP-Adressen oder mache den Server über HTTPS erreichbar. Siehe Dein eigener Git-Server.

Was kostet die KI-Nutzung?

Mit Atlassian AI (Advanced) sind KI-Seiten bis zum monatlichen Kontingent ohne Zusatzkosten enthalten. Mit eigenem Schlüssel erhebt CodeDoc keine Gebühr pro Seite; dein KI-Anbieter berechnet Tokens, und der Verlauf zeigt deren Anzahl je Durchlauf. Ein mittleres Repository benötigt typischerweise 10.000–50.000 Eingabe- und 2.000–8.000 Ausgabetokens. Grobe Kosten pro Seite mit eigenem Schlüssel: Google Geminis kostenloser Tarif kostet nichts (Google kann dessen Daten zur Produktverbesserung nutzen); Claude Haiku oder ein GPT-mini-Modell meist 0,01–0,05 USD; größere Modelle (Claude Sonnet, vollständige GPT-Modelle) 0,10–0,50 USD, je nach Repositorygröße.

Kann ich verschiedene KI-Modelle für unterschiedliche KI-Seiten verwenden?

Noch nicht: Alle KI-Seiten verwenden ein Modell. Ändere es jederzeit unter Settings → Connections; der nächste Durchlauf nutzt es.

Kann ich mehrere Repositories auf einer KI-Seite dokumentieren?

Ja, bis zu 2 Repositories pro KI-Seite. Die KI erhält den Code beider und erstellt eine gemeinsame Seite.

Welche Programmiersprachen und Dateitypen werden unterstützt?

Alle Textdateien; es gibt keine Sprachbeschränkung. Wie gut die KI einen Dateityp versteht, hängt vom Modell ab. CodeDoc lässt Abhängigkeiten, Buildausgaben, Sperrdateien, minimierte Dateien, Binär- und Mediendateien aus und liest nie typische Zugangsdaten-Dateien (.env, private Schlüssel, Zertifikate, Terraform-Zustands- und Variablendateien, Zugangsdaten-Dateien), auch nicht bei passenden Einschlussmustern.

In welchen Sprachen kann die Dokumentation erstellt werden?

Englisch, Deutsch, Französisch, Spanisch, Italienisch, Portugiesisch, Japanisch, Chinesisch und Koreanisch stehen in der Liste; Other language… (Andere Sprache) akzeptiert jede eingegebene Sprache (Qualität modellabhängig).

Wo wird meine Dokumentation gespeichert?

Als normale Confluence-Seite im gewählten Bereich. Du kannst sie bearbeiten, verschieben oder löschen. Weitere KI-Durchläufe aktualisieren dieselbe Seite ohne Duplikat. Bei aktivierter Prüfung wird jeder Durchlauf zuerst als [DRAFT] gekennzeichnete Seite gespeichert.

Kann ich Dokumentation vor der Veröffentlichung prüfen?

Ja. Aktiviere Review each run before it is published (Jeden Durchlauf vor Veröffentlichung prüfen) in Schritt 3. Die veröffentlichte Seite ändert sich erst beim Veröffentlichen des Entwurfs in CodeDoc. Discard (Verwerfen) lässt die veröffentlichte Seite unverändert; Undo last run (Letzten Durchlauf rückgängig machen) stellt die Version vor dem Durchlauf wieder her. Siehe Prüfung und Rückgängig machen.

Schreiben Webhook- und Zeitplanaktualisierungen die KI-Seite komplett neu?

Ja. Jede Aktualisierung liest den aktuellen Git-Code, die KI schreibt die Seite neu und CodeDoc aktualisiert die vorhandene Confluence-Seite.

Kann ich private Repositories verwenden?

Ja. CodeDoc verwendet deinen Zugriffstoken. Mit Lesezugriff funktioniert es bei öffentlichen und privaten Repositories.

Wie deinstalliere ich die App?

Gehe zu Confluence Settings → Apps → Manage apps, suche CodeDoc und klicke auf Uninstall (Deinstallieren). Danach kann die App ihre Konfiguration und gespeicherten Daten nicht mehr lesen; Atlassian hält sie 28 Tage vor und löscht sie dann (innerhalb von 21 Tagen kannst du uns um Wiederherstellung in einer neuen Installation bitten). Erstellte Confluence-Seiten bleiben in deinen Bereichen; lösche sie bei Bedarf manuell.

Support

Fragen, Fehler oder Funktionswünsche? Wir antworten üblicherweise innerhalb von 1–2 Werktagen (Montag bis Freitag).

E-Mail: support@janekbehrens.de
Fehlermeldungen und Funktionswünsche: github.com/janekbehrens/codedoc-ai-issues
Supportseite: häufige Fragen und benötigte Angaben für eine Fehlermeldung
Rechtliches: Datenschutzerklärung · Nutzungsbedingungen (EN) · Sicherheitserklärung (EN)