30 minutes
How to Dokumentation aktuell halten with Eigent
Nutze Code-Änderungen und PR-Kontext, um gezielte Dokumentations-Updates zu entwerfen — ohne umfassende Überarbeitungen oder veraltete Verweise.
What you need
- Eigent Desktop-App
- Zugriff auf die Codebasis (lokal oder verbundenes Repository)
- Dokumentations-Repository oder verbundenes Dokumentationssystem
Best for
- Entwicklerdokumentationen, READMEs, Runbooks und Migrationshinweise, die eine schnelllebige Codebasis begleiten
- Teams, die Dokumentation parallel zu häufigen Codeänderungen pflegen
- Engineers, die Release Notes oder Changelogs aus zusammengeführten PRs schreiben
Starter Prompt
Aktualisiere die Dokumentation für [Produkt/Funktion] auf Grundlage der folgenden Quellen: - den geänderten Quelldateien in [diesem Repo / verknüpften Repo] - den bestehenden Doku-Seiten, die das geänderte Verhalten erwähnen - allen verknüpften Issues, PRs, Release Notes oder öffentlichen Referenzen, die ich unten angebe Dann: - identifiziere, was für Nutzer sichtbar ist - aktualisiere nur die Dokumentation, die sich ändern muss - halte unveröffentlichte Roadmap-Inhalte, private Kundendetails und nur intern relevante Kontexte aus öffentlichen Docs heraus - bewahre die bestehende Doku-Struktur, Terminologie und Querverweise - führe die Docs-Checks aus, die zur Änderung passen Fasse vor dem Abschließen zusammen, was sich geändert hat, was du verifiziert hast und welche Aussagen du aus vertrauenswürdigen Quellen nicht belegen konntest.
Related workflows
Workflows als Skills speichern
Verwandeln Sie einen funktionierenden Eigent-Thread, Review-Regeln, Testbefehle oder Release-Checkli…
GitHub-Pull-Requests überprüfen
Regressionen, fehlende Tests und riskante Verhaltensänderungen vor der Prüfung durch Menschen erkenn…
Refaktoriere deine Codebasis
Entferne toten Code und modernisiere veraltete Muster, ohne das Verhalten zu ändern — in kleinen, gu…