Alles umzuschreiben, ist der Weg, auf dem Dokumentation ihre Stimme verliert
Wenn Sie veraltete Dokumentation in großem Maßstab korrigieren, werden Seiten meist von Grund auf neu geschrieben. Diese Vollneuschreibung verliert die Teile, die die Seite wertvoll machten: das Beispiel, für das jemand einen Nachmittag gebraucht hat, die Warnung nach einer Supportanfrage oder die Formulierung, die eine Kundin oder ein Kunde Ihnen zurückzitiert hat.
Die nützlichen Korrekturen sind eng: ein Parametername, ein Defaultwert und ein Schritt, der jetzt in anderer Reihenfolge läuft. Der Rest der Seite bleibt, wie die ursprüngliche Autorin oder der ursprüngliche Autor ihn geschrieben hat.
Um diese kleine Korrektur zu finden, lesen Sie Code und Seite und erkennen dann den konkreten Satz, der falsch ist. Diese Aufgabe ist schwerer als die Seite neu zu erzeugen. Auf dieser Detailstufe schlägt der Agent Bearbeitungen vor und zeigt sie als Diff, den eine Maintainerin oder ein Maintainer in einer Minute prüfen kann. Nichts wird veröffentlicht. Die Person, die die Seite besitzt, entscheidet.
So bauen Sie den Agent in Agent Studio auf
Prompt-Fähigkeiten halten die Dokumentationsverantwortung, Ihren Styleguide und die Seiten, die Sie bewusst als vereinfacht markiert haben und die niemals auf Genauigkeit korrigiert werden dürfen.
Der System-Prompt verlangt, dass jede Bearbeitung so klein wie möglich ist und sowohl den Originalsatz als auch den Code zitiert, der ihm widerspricht.
Er verbietet Umstrukturierung, Tonänderungen und jede Bearbeitung außer einer Korrektur. Verbesserungen, die dem Agent einfallen, gehen in eine Notiz, nicht in den Diff.
Wenn der Widerspruch aus dem gelieferten Code nicht abgeleitet werden kann, lässt der Agent den Abschnitt unverändert. Er bearbeitet nicht aus einer Vermutung.
Der GitHub-Knoten liefert den geänderten Code und die Dokumentationsquelle. Der Agent Chat-Knoten liest beides. Die konkrete Änderung ist die Frage.
Vorgeschlagene Bearbeitungen werden als Pull Request über den GitHub-Knoten eingereicht, ein Pull Request je Seite, mit dem Widerspruch in der Beschreibung.
Es erfolgt kein Merge. Ein Human in the Loop-Knoten sendet jeden Pull Request an die Ownerin oder den Owner der Seite. Als vereinfacht markierte Seiten kommen nie in die Warteschlange.
Woraus dieser Agent besteht
- Prompt-Fähigkeiten: Verantwortung, Styleguide und die Seiten, die bewusst vereinfacht bleiben.
- System-Prompt: minimale Bearbeitungen, mit Zitat des Satzes und des widersprechenden Codes.
- System-Prompt: keine Umstrukturierung, keine Tonänderungen. Verbesserungen gehen in eine Notiz.
- System-Prompt: keine Bearbeitung, wo der Widerspruch nicht feststellbar ist.
- GitHub (Integration): der geänderte Code und die Dokumentationsquelle zusammen.
- Agent Chat (Util): liest beides, mit der konkreten Änderung als Frage.
- Wenn ein ActionFlow ausreicht: Wenn Sie nur die Abschnitte markieren müssen, denen eine Änderung widerspricht, bauen Sie den Workflow. Viele Teams wollen nur die Markierung.
Häufige Fragen
Newsletter
Produktupdates erhalten
Neue Nodes, Agents und Produktnotizen. Wir senden E-Mails nur, wenn sich das Öffnen lohnt.