Anwendungsfall für Codex
Dokumentation aktuell halten
Nutze Code und weitere Quellen, um deine Dokumentation automatisch zu aktualisieren.
Gleiche mit Codex Änderungen am Quellcode mit der öffentlichen Dokumentation, den Release Notes und Informationen aus Pull Requests ab. Lass Codex anschließend gezielte Änderungen an der Dokumentation entwerfen und beschreiben, wie du sie vor der Veröffentlichung überprüfst.
Besonders geeignet für
- Entwicklerdokumentation, READMEs, Runbooks, Beispiele und Migrationshinweise, die du häufig an geändertes Produktverhalten anpassen musst.
- Teams, die die Dokumentation für ein technisches Produkt pflegen.
Inhalt
Dokumentation aktuell halten
Nutze Code und weitere Quellen, um deine Dokumentation automatisch zu aktualisieren.
Gleiche mit Codex Änderungen am Quellcode mit der öffentlichen Dokumentation, den Release Notes und Informationen aus Pull Requests ab. Lass Codex anschließend gezielte Änderungen an der Dokumentation entwerfen und beschreiben, wie du sie vor der Veröffentlichung überprüfst.
Gleiche mit Codex Änderungen am Quellcode mit der öffentlichen Dokumentation, den Release Notes und Informationen aus Pull Requests ab. Lass Codex anschließend gezielte Änderungen an der Dokumentation entwerfen und beschreiben, wie du sie vor der Veröffentlichung überprüfst.
Weiterführende Links
Besonders geeignet für
- Entwicklerdokumentation, READMEs, Runbooks, Beispiele und Migrationshinweise, die du häufig an geändertes Produktverhalten anpassen musst.
- Teams, die die Dokumentation für ein technisches Produkt pflegen.
Skills und Plug-ins
- Wenn du Fehlermeldungen über GitHub entgegennimmst, sieh dir Issues, Pull Requests, Kommentare, Diskussionen in Reviews und die Ergebnisse fehlgeschlagener Prüfungen an.
| Skill | Nutzen |
|---|---|
| GitHub | Wenn du Fehlermeldungen über GitHub entgegennimmst, sieh dir Issues, Pull Requests, Kommentare, Diskussionen in Reviews und die Ergebnisse fehlgeschlagener Prüfungen an. |
Prompt für den Einstieg
Einführung
Am einfachsten hältst du die Dokumentation aktuell, wenn du sie zusammen mit dem Quellcode überarbeitest. Wochen später ist der Aufwand größer. Codex kann geänderten Code, Tests, Versionshinweise, verknüpfte Issues und den Kontext eines Pull Requests auswerten. Auf dieser Grundlage kann Codex gezielte Änderungen an der Dokumentation entwerfen, die zur bestehenden Struktur passen.
Nutze diesen Ablauf für Dokumentation für Entwicklerteams, Änderungen an README-Dateien, Changelog-Entwürfe, Migrationshinweise, Runbooks und andere Dokumente, die häufige Änderungen am Verhalten der Software abbilden müssen.
So gehst du vor
-
Geh von der Änderung aus, die du dokumentieren musst.
Gib Codex den Branch, den Pull Request, den Commit, das Issue oder die betreffenden Dateien. Wenn die Dokumentation öffentlich ist, weise ausdrücklich darauf hin, dass unveröffentlichte Produktpläne, vertrauliche Kundeninformationen und rein interne Hintergründe außen vor bleiben sollen.
-
Lass Codex die betroffenen Stellen in der Dokumentation ermitteln.
Bitte Codex, vor dem Entwurf die bestehende Dokumentation nach Funktionsnamen, Konfigurationsschlüsseln, Befehlen, Beispielen und verwandten Begriffen zu durchsuchen.
-
Beschränke die Aktualisierung auf die nötigen Stellen.
Codex sollte die bestehende Seitenstruktur, die Terminologie, die Querverweise und das Frontmatter beibehalten. Wenn ein präziser Hinweis, ein Beispiel oder die Überarbeitung eines einzelnen Abschnitts ausreicht, sollte Codex auf umfangreiche Neufassungen verzichten.
-
Überprüfe die Änderungen.
Bitte Codex, die für das Repository geeigneten Formatierungs- und Dokumentationsprüfungen auszuführen. Anschließend soll Codex für jede Aussage in der Dokumentation zusammenfassen, worauf sie sich stützt.
Was du Codex bereitstellen kannst
| Quelle | Nutzen |
|---|---|
| Geänderter Code und Tests | Damit kann Codex das tatsächliche Verhalten analysieren und gezielte Änderungen an der Dokumentation entwerfen. |
| Öffentliche Versionshinweise oder Produktdokumentation | Damit kann Codex die öffentlich verwendeten Begriffe übernehmen und prüfen, welchen Status eine Funktion hat und für wen sie verfügbar ist. |
| Kontext aus dem Pull Request oder Issue | Daraus geht hervor, warum es zu der Änderung kam und welches Verhalten für die Nutzung relevant ist. |
| Lokale Dokumentationsprüfungen | Damit weiß Codex, welche Kriterien die Dokumentation vor der Veröffentlichung erfüllen muss. |
Mit zusätzlichem Kontext, etwa öffentlichen Versionshinweisen, kann Codex vermeiden, dass vertrauliche Informationen oder noch unveröffentlichte Änderungen in die Dokumentation gelangen.
Den Ablauf wiederverwenden
Wenn die Vorgaben für die Dokumentation im gesamten Repository gelten sollen, halte sie in AGENTS.md fest. So kannst du sie formulieren:
## 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 Ablauf weitere Schritte umfasst, kannst du daraus einen Skill erstellen. So kann Codex auch bei künftigen Aufgaben nach demselben Ablauf die Quellen prüfen, Änderungen entwerfen und das Ergebnis überprüfen. Mehr dazu erfährst du im Artikel Arbeitsabläufe als Skills speichern.
Du kannst auch direkt im aktuellen Chat eine Aufgabe für diesen Ablauf planen. Bitte Codex zum Beispiel, jede Woche die neuesten Pull Requests auf GitHub abzurufen und die Dokumentation entsprechend zu aktualisieren:
Verwandte Anwendungsfälle
Browserspiele entwickeln
Beschreibe deine Spielidee kurz. Codex kann daraus einen konkreten Plan entwickeln und ihn...
Code migrieren
Ordne mit Codex die Bestandteile eines Altsystems dem neuen Stack zu
Deine Codebasis refaktorieren
Entferne mit Codex toten Code, gliedere große Dateien übersichtlicher, führe doppelte Logik...