Skip to content

docs: Freshness-Audit 2026-07-27 - #14

Open
freshness-audit-bot[bot] wants to merge 1 commit into
mainfrom
chore/freshness-audit
Open

docs: Freshness-Audit 2026-07-27#14
freshness-audit-bot[bot] wants to merge 1 commit into
mainfrom
chore/freshness-audit

Conversation

@freshness-audit-bot

Copy link
Copy Markdown
Contributor

Freshness-Audit

Automatischer Lauf vom 2026-07-27. Geaenderte Dateien:

  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md
  • docs/architecture.md
  • src/metadata/README.md

STATUS: UPDATED

Gefundene Abweichungen

  1. CHANGELOG.md:14 — Eintrag lautete "9-field prioritization matrix with German recommendations". Verifiziert gegen src/data/recommendations.json: alle 29 Recommendation-Objekte (title/body/tags) sowie alle Cell-Felder (priority_label, subtitle, scale_center_hint) sind vollständig auf Englisch. Die deutsche Sprachfassung stammte aus dem initialen Bootstrap-Commit (864e8f7) und wurde spätestens mit Commit e7db664 ("refactor: refocus recommendations...") durch englischen Text ersetzt. Die Changelog-Zeile wurde nie nachgezogen.

  2. CONTRIBUTING.md (JSON-Schema-Tabellen, Zeilen ~48-65, und Abschnitt "Recommendation Content Guidelines") — Beschrieb priority_label, subtitle, scale_center_hint, sowie Recommendation-title/body durchgängig als "German" und enthielt die explizite Anweisung "Recommendation bodies should be in German (we will add i18n later)". Verifiziert: src/data/recommendations.json enthält keinerlei deutschen Text mehr (siehe Punkt 1). Zusätzlich beschrieb die Tabelle das Feld icon als "Emoji icon" — im aktuellen Code (src/data/recommendations.json, z.B. "icon": "zap") sind das aber Namens-Keys, die in src/js/matrix.js (ICONS-Map) auf SVG-Icons gemappt werden, keine Emoji-Zeichen mehr (ursprünglich war es ein Emoji, z.B. "⚡" im Bootstrap-Commit).

  3. docs/architecture.md (Abschnitt "Basic Mode (OCR)", Schritte 2 und 4) — Beschrieb den OCR-Ablauf als "crops the top 30% of the image (counter region)" gefolgt von "Regex patterns extract six counter values". Verifiziert gegen src/js/ocr.js: Für das aktuelle (und einzige kalibrierte) Layout org-performance schneidet der Code sechs einzelne Counter-Tiles individuell zu (ORG_PERF_LAYOUT, Zeilen 48-80, numberRowTop: 0.113 / numberRowBottom: 0.128 — nicht "top 30%") und liest sie per Per-Tile-OCR aus (ocrCounterTile, Zeile 110ff.). Der beschriebene "top 30% Crop + Label-Regex"-Ansatz existiert im Code nur noch als Fallback für unbekannte/legacy Layouts (Zeile 239ff.). Diese Zeilen wurden beim letzten Freshness-Audit (Commit 1cb112d, 2026-07-25) nicht mit angepasst, obwohl im selben Commit die Modulstruktur-Baumdarstellung weiter oben in derselben Datei aktualisiert wurde.

  4. src/metadata/README.md (Abschnitt "Analyzers") — Listete nur drei Analyzer (apexCpuAnalyzer, apexRowLockAnalyzer, flowAnalyzer). Verifiziert gegen src/metadata/analyzers/index.js: Es ist ein vierter, registrierter Analyzer metadataAnalyzer vorhanden (roll-up/Workflow/Trigger-Duplikat-Erkennung), der laut Commit-Historie (f71549b, 2026-04-23) hinzugefügt wurde — nach dem letzten Bearbeitungsdatum dieser Datei (2026-04-17 laut Kontext). Das entspricht exakt der bereits in CHANGELOG.md korrekt beschriebenen Funktion "roll-up/workflow/trigger duplicate detection". Zusätzlich deckte die flowAnalyzer-Beschreibung die neueren "Get Records"-Muster (redundante Fetches, fehlende Filter, nicht indizierte Felder, heap-lastige Felder) aus Commit 92f9e41 (2026-04-23) nicht ab.

  5. README.md:7-8 — Die beiden Header-Badges waren als Links mit leerem Ziel formatiert ([![...]()]()), was die Link-Prüfung als Fehler meldet ("Empty URL found but a URL must not be empty"). Die Badges selbst (Status, License) sind korrekt und aktuell — nur der leere Link-Wrapper war fehlerhaft.

Vorgenommene Aenderungen

  • CHANGELOG.md: "9-field prioritization matrix with German recommendations" → "9-field prioritization matrix with recommendations".
  • CONTRIBUTING.md: Sprachangaben für priority_label, subtitle, scale_center_hint, Recommendation-title/body von "German" auf "English" korrigiert; icon-Feldbeschreibung von "Emoji icon" auf "Icon name ... (e.g. zap)" korrigiert; Guideline-Satz "Recommendation bodies should be in German (we will add i18n later)" auf "should be in English" korrigiert.
  • docs/architecture.md: Basic-Mode-Datenfluss (Schritte 2 und 4) korrigiert, um Per-Tile-OCR gegen ORG_PERF_LAYOUT und den Digit-Regex-Parser pro Tile zu beschreiben, inkl. Hinweis auf den Label-Regex-Fallback für das Legacy-Layout.
  • src/metadata/README.md: Bullet für metadataAnalyzer ergänzt; flowAnalyzer-Bullet um Subflow-in-Loop- und Get-Records-Muster erweitert.
  • README.md: Leere Link-Wrapper um die beiden Header-Badges entfernt (Bilder bleiben unverändert sichtbar, verlinken aber nicht mehr auf eine leere URL).

Offene Punkte fuer manuelle Pruefung

  • LinkedIn-Links (README.md:178, 180-181): Die Link-Prüfung meldet Status 999 für beide linkedin.com/in/...-Profile. Status 999 ist eine bekannte Anti-Scraping-Antwort von LinkedIn auf automatisierte Anfragen (kein Browser-User-Agent), kein Beleg für einen tatsächlich toten Link. Die URLs selbst sehen syntaktisch plausibel aus; eine manuelle Prüfung im Browser wird empfohlen, bevor sie geändert werden.
  • ROADMAP.md ("Phase 0: Soft Launch (Current — Private Beta)"): Diese Datei wurde seit dem initialen Bootstrap-Commit nie aktualisiert. Mehrere Indizien im Repo deuten darauf hin, dass der Stand weiter fortgeschritten ist als hier dargestellt (README-Badge zeigt bereits "public beta", docs/deploy-pages.yml und eine dokumentierte Live-URL existieren, das Projekt wurde bereits öffentlich auf einer Konferenz vorgestellt), während die Checkliste "Make repository public" / "Publish to GitHub Pages" noch unangehakt ist. Ob das Repository auf GitHub tatsächlich bereits public ist, lässt sich aus dem Dateisystem nicht verifizieren — daher wurde hier bewusst nichts geändert, um keine Roadmap-/Statusaussagen zu erfinden. Empfehlung: Maintainer sollte die Checkliste manuell abgleichen.
  • docs/REPO_REVIEW.md und docs/RECOMMENDATIONS_AUDIT.md: Beides sind explizit datierte Point-in-Time-Berichte (19./18. April 2026). Einzelne darin genannte Fakten sind mittlerweile überholt (z.B. Modell-IDs, Anzahl Recommendations: Bericht nennt 24, aktuell sind es 29; CI führt laut Bericht keine Tests aus). Da beide Dokumente sich selbst explizit als historische Snapshots ausweisen ("reflects the findings as originally identified"), wurden sie nicht angepasst — eine Aktualisierung würde den Charakter als Zeitpunkt-Audit verfälschen. Falls gewünscht, könnte der Maintainer stattdessen einen Hinweis ergänzen, dass die Zahlen inzwischen abweichen.
  • tesseract.js-Abhängigkeit: package.json deklariert ^5.1.1, aktuell verfügbar ist 7.0.0 (siehe erhobene Fakten). Dies ist keine Dokumentationsabweichung (keine Doku behauptet eine andere Version), sondern ein reiner Dependency-Update-Punkt außerhalb des Auftragsumfangs (kein Produktivcode/Lockfile wurde angefasst).

Branch wird bei jedem Lauf ueberschrieben. Aenderungen sind auf die
konfigurierte Pfad-Allowlist begrenzt, Produktivcode wird nicht angefasst.

Automatisch erzeugt durch den woechentlichen OSS-Freshness-Audit.
Nur Dokumentation und Metadaten, kein Produktivcode.
@freshness-audit-bot freshness-audit-bot Bot added the documentation Improvements or additions to documentation label Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants