mrgnhnt96/impa-review

Was macht impa-review?

Startet eine technische Dokumentationsprüfung in einer eigenen, gesperrten Sitzung und gibt den Bericht zurück. Es arbeitet mit jeder Dokumentation, ohne dass ein Autor beteiligt ist. Nur Ergebnisse: Es bearbeitet weder die Dokumente noch den Code, selbst wenn nach „Review und Fix“ gefragt wird.

Lies nicht method.md, checklist.md oder irgendetwas in reference/. Der Reviewer lädt diese selbst – das ist der Sinn, sie aus dieser Sitzung herauszuhalten.

Wenn du diese Dokumente in dieser Sitzung geschrieben oder geändert hast, folge stattdessen round.md.

Schritte

1. Schreibe das Briefing nach "${TMPDIR:-/tmp}"/impa/<projekt>/direkt-<n>/brief-1.md, wobei <n> eins höher ist als der letzte Ordner dort. Es enthält Fakten und niemals deine Meinung, also lies die Dokumente nicht zuerst:

   Technische Dokumentationen nach der Impa-Review-Methode prüfen. Keine Dateien bearbeiten.
   
   Projekt: <absoluter Pfad>
   Dokumente: <absolute Pfade, die der Benutzer genannt hat, oder „finde sie“>
   Andere Quellen: <absolute Pfade von Abhängigkeiten oder Schwester-Repos, die der Benutzer genannt hat, oder „keine“>
   Dokumentenplan: <absoluter Pfad zu .impa/plan.md, falls das Projekt einen hat, oder „keiner“>
   Anfrage dieser Runde, in den Worten des Benutzers: "<Aufforderung>"
   Umfang: <was der Benutzer genannt hat, oder „das gesamte Dokumentenset“>
   Noch offen aus der letzten Runde: nichts
   An eine Person übergeben: nichts
   
   Gib den Bericht der Methode zurück. Nenne jedes Problem außerhalb des Umfangs, das dir zufällig auffällt, suche aber nicht danach.
   

2. Starte es im Hintergrund. Füge --add-dir für jeden Pfad unter „Andere Quellen“ hinzu:

   impa review --brief <brief> --add-dir <projekt>
   

   Ein großes Dokumentenset benötigt möglicherweise --timeout <minuten>, standardmäßig 20.

3. Wenn der Befehl mit Exit-Code 1 endet, war die Prüfung nicht abgeschlossen, und jedes review-1.md ist unvollständig. Ohne review-1.json oder mit einem error, der mit Error: spawn beginnt, konnte die Prüfung nicht starten: Lies, was der Befehl ausgegeben hat, und verwende dann den Fallback. Andernfalls führe ihn einmal mit einem größeren --timeout aus. Schlägt auch das fehl, teile dem Benutzer mit, dass keine Prüfung abgeschlossen wurde, und nenne den error aus review-1.json.

4. Andernfalls lies nur review-1.md neben dem Briefing. Gib es wie geschrieben zurück, mit den Kosten aus der Zeile, die der Befehl ausgegeben hat, und stoppe. Handle die Ergebnisse nicht eigenständig, es sei denn, der Benutzer fragt danach: Das Korrigieren ist ein separater Schritt nach diesem. Wenn verdict in review-1.json leer ist, gibt es keine Urteilszeile; sage also, dass der Bericht nicht vertrauenswürdig ist.

Wenn impa nicht im PATH ist oder nicht starten kann, verwende den Fallback in Abschnitt 3 von round.md. Wenn auch das nicht starten kann, teile dem Benutzer mit, dass keine Prüfung durchgeführt wurde. Führe niemals eine Prüfung in dieser Sitzung durch.