Communitygithub.com

TheColliery/CoalLedger

Dokumentations-Gesundheits-Kanariensuite für KI-Codierungsagenten – CoalMine für Dokumentation. Enthält 6+1 Kanarienvögel, erkennt Dokumentstruktur mit einer Zero-Dep CommonMark+GFM-AST-Engine, bewertet Schweregrad nach Kontext und erzwingt Fixes nur durch Auswahl, niemals automatisch.

Was ist CoalLedger?

CoalLedger ist eine spezialisierte Kanariensuite, die von TheColliery entwickelt wurde und darauf ausgelegt ist, dass KI-Codierungsagenten wie Claude Code oder Cursor die Dokumentationsqualität überwachen. Das Skill besteht aus 6+1 Kanarienvögeln, die automatisch die Struktur der Dokumentation mittels einer CommonMark+GFM-AST-Engine erkennen, die keine externen Abhängigkeiten benötigt. Es erkennt zwei Arten von Problemen: veraltete Inhalte (Doc-Rot), die durch Altersmarken wie Versionen oder Daten identifiziert werden, und informiert auch über Änderungen an Dokumenten, die nicht im MEMORY.md nachgetragen wurden. Der Schweregrad wird dynamisch nach Kontext bestimmt – veraltete Installationsschritte sind kritisch, ein kleines Badge-Update ist mittelschwer. Fixes werden niemals automatisch angewendet, sondern immer zur Auswahl gestellt, um unerwünschte Änderungen zu vermeiden. Das Skill unterstützt GitHub Issues als Eskalationspfad für Fehlverhalten und arbeitet plattformunabhängig mit allen gängigen Textagenten wie Claude Code, Cursor, Codex, Copilot und Aider.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add TheColliery/CoalLedger

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Doc-Rot

Antworte in der SPRACHE DES BENUTZERS; behalte technische Begriffe, Befehle, Pfade und Check-IDs wörtlich bei.

Finde Dokumentinhalte, die durch Zeit ungültig geworden sind. Melde BESTÄTIGTE Fäulnis; parke das lediglich Alte unter VERDÄCHTIG.

Parameter

  • SCOPE: benannte Dateien (Standard bei Angabe) | berührte Dokumentdateien dieser Sitzung | gesamtes Repository-Dokumente — .md/.mdx/.markdown/.rst/.txt/.adoc/.asciidoc/.org (bei > 20 Dateien zuerst bestätigen).
  • TIER: Quick = nur mechanische Altersmarkierungen (~kostenlos) · Full = semantische Staleness-Bewertung (kostenpflichtig). Standard aus .coalledger.json quickVsFull; Full erfordert immer separate Zustimmung.

Altersmarkierungen (mechanische Schicht — deterministische Erkennung)

MarkerSignal
VersionszeichenketteDokument nennt eine Version älter als die aktuelle des Projekts (Vergleich mit der Wahrheitsquelle der Version, z. B. dem Manifest)
DatumsstempelEin „zuletzt aktualisiert“ / „erneut validieren bis“ / „verifiziert am“-Datum weit in der Vergangenheit oder bereits überschritten
toter AufgabenmarkerTODO / FIXME / „in Kürze“ / „noch nicht“ ohne Lebenszeichen
veraltetes BadgeEin fest codiertes Status-/Versionsbadge, dem der Repository-Zustand widerspricht

Die Erkennung ist deterministisch; ob ein Marker Fäulnis bedeutet, ist es nicht – ein altes Datum in einem Archiv ist in Ordnung, in einer Installationsanleitung nicht.

Methode

  1. Quick: Sammle Altersmarkierungen gemäß Tabelle. Alt ≠ verrottet: Ein einzelner Marker landet in VERDÄCHTIG.
  2. Full: Bewerte jeden Marker im Kontext und jage nach UNBEMERKTER Fäulnis – Anweisungen für eine Oberfläche, die sich geändert hat, Behauptungen, die ein späteres Dokument außer Kraft setzt (reiner Widerspruch zwischen Live-Dokumenten gehört zur Dokument-Konsistenz; Fäulnis ist die Zeitachse).
  3. Vorher bestätigen vor BESTÄTIGT: Ein Befund ist nur BESTÄTIGT, wenn der aktuelle Zustand dem Dokument widerspricht (die Versionsquelle nennt eine neuere Version; die referenzierte Oberfläche ist verschwunden). Alles Geschlussfolgerte bleibt VERDÄCHTIG.
  4. Schweregrad nach KONTEXT (niemals eine feste Zuordnung), dann achte auf severityFloor: Verrottete Installations-/Sicherheitsschritte, denen Leser folgen = HOCH-KRITISCH; ein veraltetes Badge oder eine Versionserwähnung = MITTEL; ein altes Datum in einem archivierten Dokument = NIEDRIG.

Eskalationsgrenze

Ob eine Behauptung JE wahr war, ist Sache der Dokumentenverankerung; formale Verifikation einer hoch riskanten Behauptung eskaliert an CoalBoard (/coalboard), falls dieses Skill installiert ist. Dieser Kanarienvogel antwortet nur auf „Hat die Zeit es zerstört?“.

Ausgabe

| # | Pfad:Zeile | Marker | Beweis (aktueller Zustand) | Schweregrad | Fix |

Nur BESTÄTIGT-Tabelle; VERDÄCHTIG (alt, aber unbewiesen) als separate Liste, niemals die Haupttabelle.

Berichterstattung: Rufe ReportFindings auf, wenn aufrufbar – file/line MUSS die eigene Zeile des Markers sein, niemals eine Paraphrase; eine nicht auflösbare Zeile meldet deine beste Schätzung, benannt als ungenau im Abschlussbericht, niemals weggelassen. Schweregrad im summary vorangestellt (z. B. [HIGH] …) gemäß der Regel Schweregrad nach Kontext oben, sortiert schwerstes zuerst, VERDÄCHTIG (alt, aber unbewiesen) als verdict: PLAUSIBLE; Chat führt dann nur die Abschlusszeile (Anzahl · VERDÄCHTIG-Liste · Überlauf über 32) + das Fix-Menü, niemals eine Nacherzählung. Nicht aufrufbar → die Tabelle oben, unverändert. Ein Klick auf Fixes anwenden = Zustimmung zur Klasse Anwenden-sicherer-Fixes unten (nur eindeutige Aktualisierungen des aktuellen Werts), die den Fix-Modus ergänzt – nie umgeht. Nach jeder Fix-Runde melde dieselben Befunde erneut mit outcome: fixed/skipped/no_change_needed.

Fix-Modus (auswahlgesteuert)

Nach jedem Bericht in einer interaktiven Sitzung MUSST du dieses Menü über dein Fragewerkzeug präsentieren (überspringe nur, wenn die Befunde null sind oder kein Benutzer anwesend ist). NIEMALS ein Live-Dokument automatisch reparieren.

  • Sichere Fixes anwenden: nur Aktualisierungen, deren aktueller Wert eindeutig ist (eine Versionszeichenkette auf die des Manifests erhöhen, ein vom Benutzer bestätigtes Datum aktualisieren, einen vom Benutzer als tot bestätigten TODO löschen). Jeder Fix: Checkpoint (git stash/commit in einem Git-Repo; sonst die Datei beiseite kopieren – niemals annehmen, dass Git existiert) -> anwenden -> die geänderten Zeilen erneut lesen.
  • Lass mich auswählen: Befunde auflisten; der Benutzer wählt aus.
  • Nur Bericht: unverändert beenden.

NIEMALS automatisch reparieren: Überschreiben von veralteten Anleitungen (eine inhaltliche Entscheidung), Löschen von Abschnitten, alles, dessen aktuelle Wahrheit du nicht überprüft hast.

Mehrsprachig

Altersmarker sind sprachunabhängig (Versionen, Daten und Badges sehen in jeder Prosa-Sprache gleich aus; DatumsFORMATE variieren – nach Struktur parsen, nicht nach einem englischen Monatsnamen). Semantische Bewertung reduziert sich bei einer schlecht beherrschten Sprache auf Low-Confidence-Flags, niemals auf Fehlalarme.

Problembericht

Falls dieser Kanarienvogel sich falsch verhält, BIETE an, ihn unter https://github.com/TheColliery/CoalLedger/issues mit einer vom Benutzer überprüften Zusammenfassung zu melden – niemals automatisch einreichen.

Verwandte Skills