For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Hauptnavigation

Vorschläge
API Dashboard
ChatGPT ausprobieren
Codex

Codex use case

Dokumentation aktuell halten

Nutze Code und andere Quellen, um Aktualisierungen der Dokumentation zu automatisieren.

Difficulty Einfach
Time horizon 30 min

Nutze Codex, um Änderungen am Quellcode, öffentliche Dokumentation, Versionshinweise und den Kontext von Pull Requests zu vergleichen, daraus gezielte Aktualisierungen der Dokumentation zu entwerfen und diese vor der Veröffentlichung zu prüfen.

Am besten geeignet für

  • Entwicklerdokumentation, READMEs, Runbooks, Beispiele und Migrationshinweise, die häufige Verhaltensänderungen berücksichtigen müssen.
  • Teams, die Dokumentation für ein technisches Produkt pflegen.

Contents

    ← Alle Anwendungsfälle

    Dokumentation aktuell halten

    Nutze Code und andere Quellen, um Aktualisierungen der Dokumentation zu automatisieren.

    Nutze Codex, um Änderungen am Quellcode, öffentliche Dokumentation, Versionshinweise und den Kontext von Pull Requests zu vergleichen, daraus gezielte Aktualisierungen der Dokumentation zu entwerfen und diese vor der Veröffentlichung zu prüfen.

    Einfach
    30 min

    Nutze Codex, um Änderungen am Quellcode, öffentliche Dokumentation, Versionshinweise und den Kontext von Pull Requests zu vergleichen, daraus gezielte Aktualisierungen der Dokumentation zu entwerfen und diese vor der Veröffentlichung zu prüfen.

    Einfach
    30 min

    Weiterführende Links

    Arbeitsabläufe

    Am besten geeignet für

    • Entwicklerdokumentation, READMEs, Runbooks, Beispiele und Migrationshinweise, die häufige Verhaltensänderungen berücksichtigen müssen.
    • Teams, die Dokumentation für ein technisches Produkt pflegen.

    Skills und Plug-ins

    • GitHub
      Lies Issues, Pull Requests, Kommentare, Review-Threads und fehlgeschlagene Checks, wenn du Fehlermeldungen über GitHub entgegennimmst.
    Skill Why use it
    GitHub Lies Issues, Pull Requests, Kommentare, Review-Threads und fehlgeschlagene Checks, wenn du Fehlermeldungen über GitHub entgegennimmst.

    Einstiegs-Prompt

    Aktualisiere die Dokumentation zu [product/feature] anhand der folgenden Quellen: - die geänderten Quelldateien in [this repo/source linked repo] - vorhandene Dokumentationsseiten, auf denen ein neues Verhalten erwähnt wird - alle verknüpften Issues, Pull Requests, Versionshinweise oder öffentlichen Quellen, die ich unten angebe Gehe anschließend wie folgt vor: - Ermittle, was für Nutzende sichtbar ist - Aktualisiere nur die Teile der Dokumentation, die geändert werden müssen - Nimm unveröffentlichte Roadmap-Inhalte, vertrauliche Kundeninformationen und rein internen Kontext nicht in die öffentliche Dokumentation auf - Behalte die bestehende Struktur, Terminologie und Querverweise der Dokumentation bei - Führe die zur Änderung passenden Dokumentationsprüfungen aus Fasse vor dem Abschluss zusammen, was geändert wurde, was du geprüft hast und welche Aussagen sich nicht anhand vertrauenswürdiger Quellen belegen ließen. [link release notes or other references here]
    Aktualisiere die Dokumentation zu [product/feature] anhand der folgenden Quellen: - die geänderten Quelldateien in [this repo/source linked repo] - vorhandene Dokumentationsseiten, auf denen ein neues Verhalten erwähnt wird - alle verknüpften Issues, Pull Requests, Versionshinweise oder öffentlichen Quellen, die ich unten angebe Gehe anschließend wie folgt vor: - Ermittle, was für Nutzende sichtbar ist - Aktualisiere nur die Teile der Dokumentation, die geändert werden müssen - Nimm unveröffentlichte Roadmap-Inhalte, vertrauliche Kundeninformationen und rein internen Kontext nicht in die öffentliche Dokumentation auf - Behalte die bestehende Struktur, Terminologie und Querverweise der Dokumentation bei - Führe die zur Änderung passenden Dokumentationsprüfungen aus Fasse vor dem Abschluss zusammen, was geändert wurde, was du geprüft hast und welche Aussagen sich nicht anhand vertrauenswürdiger Quellen belegen ließen. [link release notes or other references here]

    Einführung

    Dokumentation lässt sich am einfachsten aktuell halten, wenn sie zusammen mit Änderungen am Quellcode aktualisiert wird und nicht erst Wochen später. Codex kann geänderten Code, Tests, Versionshinweise, verknüpfte Issues und den Kontext von Pull Requests prüfen und anschließend eine gezielte Aktualisierung der Dokumentation entwerfen, die zur bestehenden Struktur passt.

    Nutze diesen Arbeitsablauf für Entwicklerdokumentation, README-Aktualisierungen, Entwürfe für Änderungsprotokolle, Migrationshinweise, Runbooks und alles andere, was häufige Verhaltensänderungen berücksichtigen muss.

    So gehst du vor

    1. Beginne mit der Änderung, die du dokumentieren musst.

      Stelle den Branch, den Pull Request, den Commit, das Issue oder die Dateien bereit. Wenn die Dokumentation öffentlich ist, sage ausdrücklich, dass unveröffentlichte Roadmap-Inhalte, vertrauliche Kundeninformationen und rein interner Kontext nicht aufgenommen werden dürfen.

    2. Bitte Codex, die betroffenen Dokumentationsseiten zu ermitteln.

      Lass Codex die bestehende Dokumentation vor dem Entwurf nach Funktionsnamen, Konfigurationsschlüsseln, Befehlen, Beispielen und verwandten Begriffen durchsuchen.

    3. Beschränke die Aktualisierung auf den kleinsten sinnvollen Teil der Dokumentation.

      Codex sollte die aktuelle Seitenstruktur, Terminologie, Querverweise und Frontmatter beibehalten. Wenn die gezielte Aktualisierung eines Hinweises, Beispiels oder Abschnitts ausreicht, sollte Codex keine umfassenden Überarbeitungen vornehmen.

    4. Prüfe die Änderungen.

      Bitte Codex, die zum Repository passenden Formatierungs- und Dokumentationsprüfungen auszuführen. Lass Codex anschließend zusammenfassen, welche Belege jede für Nutzende relevante Aussage stützen.

    Was du Codex bereitstellen solltest

    QuelleWarum das hilft
    Änderungen an Code und TestsDamit kann Codex das tatsächliche Verhalten analysieren und gezielte Aktualisierungen der Dokumentation entwerfen.
    Öffentliche Versionshinweise oder ProduktdokumentationHilft Codex, sich bei Terminologie, Verfügbarkeit und Funktionsstatus an den öffentlichen Angaben zu orientieren.
    Kontext eines Pull Requests oder IssuesErklärt, warum die Änderung vorgenommen wurde und welches für Nutzende sichtbare Verhalten relevant ist.
    Lokale DokumentationsprüfungenGibt Codex konkrete Kriterien, die vor der Veröffentlichung der Dokumentation erfüllt sein müssen.

    Mit zusätzlichem Kontext wie öffentlichen Versionshinweisen kann Codex vermeiden, vertrauliche Informationen oder noch nicht veröffentlichte Aktualisierungen aufzunehmen.

    Arbeitsablauf wiederholbar machen

    Um eine Konvention für das gesamte Repository festzulegen, trage die Vorgaben zur Dokumentation in AGENTS.md ein. Beispiel:

    ## Documentation

- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.

    Wenn der Prozess weitere Schritte umfasst, erstelle daraus einen Skill. So können künftige Codex-Aufgaben demselben Ablauf aus Quellenprüfung, Entwurf und Verifizierung folgen. Weitere Informationen zu diesem Muster findest du unter Arbeitsabläufe als Skills speichern.

    Du kannst auch direkt aus dem aktuellen Chat eine Aufgabe für diesen Arbeitsablauf planen. Bitte Codex beispielsweise, jede Woche die neuesten Pull Requests auf GitHub abzurufen und die Dokumentation aktuell zu halten:

    Plane direkt aus diesem Chat eine Aufgabe für den oben beschriebenen Arbeitsablauf. Rufe alle aktuellen Pull Requests in [this repo/linked repo] ab und aktualisiere die Dokumentation anhand der Änderungen.

    Verwandte Anwendungsfälle

    Eine CLI erstellen, die Codex nutzen kann

    Bitte Codex, eine flexibel kombinierbare CLI zu erstellen

    Entwicklung Code

    Browserbasierte Spiele erstellen

    Verwende Codex, um aus einer Spielbeschreibung zunächst einen klar definierten Plan und...

    Entwicklung Code

    Ein Ziel verfolgen

    Verwende `/goal`, wenn Codex bei einer Aufgabe über mehrere Interaktionen hinweg auf eine...

    Entwicklung Automatisierung