document-release

Überblick über die document-release-Skill

Wofür document-release gedacht ist

document-release ist eine Skill für Dokumentations-Updates nach dem Shipping und sorgt dafür, dass Projekt-Dokus mit dem tatsächlich ausgelieferten Stand übereinstimmen. Sie liest die Dokumentation, vergleicht sie mit dem aktuellen Diff und hilft dabei, Dateien wie README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md und VERSION zu aktualisieren, wenn ein Release die Story verändert.

Wer sie einsetzen sollte

Diese document-release-Skill ist ideal für Technical Writer, Repo-Maintainer und Agenten, die gemergten Code mit weniger manuellem Gegencheck in präzise Dokumentation überführen müssen. Besonders nützlich ist sie, wenn der Code fertig ist, die Doku aber noch das alte Verhalten beschreibt.

Warum das in der Praxis wichtig ist

Die eigentliche Aufgabe ist nicht allgemeines Schreiben, sondern Release-Synchronisierung. Die Skill ist dann wertvoll, wenn Sie einen verlässlichen document-release-Leitfaden brauchen, der Fließtext aktualisiert, veraltete TODOs entfernt und Release Notes konsistent zu den ausgelieferten Änderungen hält, statt eine neue Erzählung von Grund auf zu erfinden.

So verwenden Sie die document-release-Skill

Installieren und korrekt auslösen

Nutzen Sie den document-release-Installationsablauf in Ihrer Agenten-Umgebung und rufen Sie ihn dann auf, wenn ein PR gemergt wurde, Code ausgeliefert ist oder jemand explizit sagt, die Doku zu aktualisieren oder die Dokumentation zu synchronisieren. Die Skill ist für den Einsatz nach der Implementierung gedacht, nicht für explorative Entwurfsphasen.

Mit den richtigen Eingaben starten

Starke Prompts enthalten den ausgelieferten Diff, die betroffenen Dateien, die Zielgruppe und alle Release-Einschränkungen. Eine schwache Anfrage wie „Update docs“ zwingt die Skill zum Raten; eine stärkere wie „Sync docs for the API rename in this merged PR and keep the changelog voice concise“ gibt ihr den nötigen Kontext, um präzise zu überarbeiten.

Diese Dateien zuerst lesen

Für die document-release-Nutzung beginnen Sie mit SKILL.md und prüfen dann die Dateien, auf die dort im Repo verwiesen wird, insbesondere README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md sowie alle Release- oder Versionsdateien. Sehen Sie sich außerdem SKILL.md.tmpl an, wenn Sie die generierte Struktur verstehen möchten und wissen wollen, was bei Updates stabil bleiben sollte.

Workflow-Tipps, die die Ausgabe verbessern

Nutzen Sie die Skill, um diese drei Fragen in genau dieser Reihenfolge zu beantworten: Was hat sich geändert? Welche Doku-Stellen beschreiben dieses Verhalten? Und was muss umgeschrieben oder entfernt werden? Wenn es im Repo aktive TODOs, veraltete Beispiele oder versionsgebundene Anweisungen gibt, nennen Sie das im Prompt ausdrücklich, damit die document-release-Skill sie bereinigen kann, statt sie zu konservieren.

document-release-Skill FAQ

Ist document-release nur für finale Releases gedacht?

Nein. Die document-release-Skill eignet sich auch für gemergte PRs und jede andere Post-Ship-Änderung, durch die veröffentlichte Doku von der Realität abweicht. Für Brainstorming vor dem Merge ist sie weniger hilfreich, nach der Änderung der Quelle der Wahrheit dafür umso mehr.

Worin unterscheidet sie sich von einem normalen Prompt?

Ein normaler Prompt kann zwar ein brauchbares Edit erzeugen, aber document-release bringt einen release-orientierten Workflow mit: Dokumentation lesen, Diff gegenprüfen, betroffene Dateien aktualisieren und Tonalität sowie Terminologie konsistent halten. Dadurch sinkt das Risiko, veraltete Anweisungen auszuliefern oder eine abhängige Doku-Datei zu übersehen.

Ist sie für Anfänger geeignet?

Ja, wenn die Person benennen kann, was ausgeliefert wurde und welche Doku das widerspiegeln muss. Anfänger erzielen die besten Ergebnisse, wenn sie eine klare Zusammenfassung der Änderung, den Zielpfad im Repo und die Dateien angeben, die voraussichtlich aktualisiert werden sollen.

Wann sollte ich sie nicht verwenden?

Verwenden Sie document-release nicht, wenn Sie nur einen groben Entwurf, eine Produktankündigung oder spekulative Dokumentation für unfertigen Code brauchen. Ebenfalls ungeeignet ist sie, wenn Sie keinen Zugriff auf die Repo-Historie oder die geänderten Dateien haben, denn die Skill muss Änderungen auf dem tatsächlich Geänderten verankern.

So verbessern Sie die document-release-Skill

Geben Sie der Skill ein präziseres Release-Briefing

Der größte Qualitätssprung entsteht, wenn Sie das genau ausgelieferte Verhalten, die betroffenen Dokumente und den gewünschten Ton klar benennen. Zum Beispiel: „Aktualisiere die Doku für den neuen Auth-Flow, entferne veraltete Setup-Schritte, halte das Changelog sachlich und ändere die Architekturhinweise nicht außerhalb des betroffenen Abschnitts.“

Machen Sie typische Fehlerquellen sichtbar

document-release arbeitet am besten, wenn Sie auf veraltete Beispiele, umbenannte Befehle, defekte Querverweise oder Versionsstrings hinweisen, die gemeinsam angepasst werden müssen. Wenn Sie wissen, dass ein Dokument maßgeblich ist und andere davon abgeleitet sind, sagen Sie das ausdrücklich; so vermeiden Sie unnötige Umschreibungen und halten die document-release-Skill fokussiert.

Nach dem ersten Durchlauf iterieren

Prüfen Sie die erste Ausgabe auf drei Dinge: fehlende Links, veraltete Screenshots oder Codebeispiele sowie abweichende Terminologie zwischen den Dateien. Geben Sie dann nur die Lücken zurück, die Sie gefunden haben. So kann der nächste Durchlauf das document-release-Installations- und Nutzungsergebnis nachschärfen, ohne stabile Abschnitte erneut anzufassen.

Verwenden Sie die Skill als Release-Checkliste

Für document-release im Technical-Writing-Kontext sollten Sie die Skill wie einen QA-Durchlauf nach dem Shipping behandeln: Prüfen Sie, ob die Doku dem ausgelieferten Verhalten entspricht, entfernen Sie überholte TODOs und verifizieren Sie versionsgebundene Anweisungen. Die besten document-release-Eingaben sind so konkret, dass das Modell den Diff mit dem Repo abgleichen kann, statt alles pauschal neu zu schreiben.