How to Dokumentation aktuell halten with Eigent

So funktioniert es

1. Teile die geänderten Quelldateien, den Branch, Pull Request oder Commit, der dokumentiert werden soll.
2. Bitte Eigent, bestehende Docs nach den betroffenen Funktionsnamen, Konfigurationsschlüsseln, Befehlen und Beispielen zu durchsuchen.
3. Aktualisiere nur die Docs, die geändert werden müssen — bewahre Seitenstruktur, Terminologie, Querverweise und Frontmatter.
4. Führe Formatierungs- und Docs-Checks aus und bitte Eigent dann, die Belege hinter jeder für Nutzer sichtbaren Aussage zusammenzufassen.
5. Prüfe die Zusammenfassung vor der Veröffentlichung, um sicherzustellen, dass keine internen oder unveröffentlichten Inhalte in die öffentlichen Docs gelangt sind.

Weitere Prompts zum Ausprobieren

• Welche bestehenden Doku-Seiten verweisen auf das Verhalten, das in diesem PR geändert wurde?
• Beeinflusst diese Änderung öffentliche API-Parameter, Standardwerte oder CLI-Flags, die aktualisiert werden müssen?
• Schreibe einen Changelog-Eintrag für dieses Release, der unserem bestehenden Format entspricht.
• Identifiziere alle für Nutzer sichtbaren Aussagen in der aktualisierten Dokumentation, die du nicht allein aus dem Quellcode verifizieren kannst.

So verwendest du es

Beginne mit der Änderung, die du dokumentieren musst — teile den Branch, PR oder Commit. Bitte Eigent, vor dem Verfassen irgendetwas in den bestehenden Docs zu suchen, damit die richtigen Seiten aktualisiert werden, statt neue Inhalte zu schreiben, die bestehende Inhalte duplizieren. Halte den Umfang eng: Eine präzise Notiz oder ein Beispiel-Update ist besser als eine vollständige Neufassung. Um das wiederholbar zu machen, speichere den Workflow als Skill oder bitte Eigent, ihn nach jedem Release nach einem Zeitplan auszuführen.

Erwartete Ausgabe

Aktualisierte Dokumentationsdateien, die nur die für Nutzer sichtbaren Änderungen abdecken, eine Zusammenfassung dessen, was geändert und verifiziert wurde, sowie eine Liste aller Aussagen, die aus vertrauenswürdigen Quellen nicht bestätigt werden konnten und eine menschliche Prüfung erfordern.

Einschränkungen

• Eigent kann nicht auf private Kundendaten, unveröffentlichte Roadmap-Punkte oder interne Wikis zugreifen, sofern du sie nicht ausdrücklich bereitstellst.
• Die Genauigkeit der Dokumentation hängt von der Qualität der Quellkommentare und der Testabdeckung ab — nicht dokumentiertes Verhalten kann übersehen werden.
• Sehr große Docs-Sites profitieren davon, die Suche auf einen bestimmten Abschnitt oder Funktionsbereich zu begrenzen, statt auf die gesamte Site.