Skip to content

docs: Freshness-Audit 2026-07-25 - #13

Merged
rammc merged 1 commit into
mainfrom
chore/freshness-audit
Jul 25, 2026
Merged

docs: Freshness-Audit 2026-07-25#13
rammc merged 1 commit into
mainfrom
chore/freshness-audit

Conversation

@freshness-audit-bot

Copy link
Copy Markdown
Contributor

Freshness-Audit

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

  • .github/ISSUE_TEMPLATE/matrix_recommendation.md
  • CHANGELOG.md
  • README.md
  • docs/architecture.md

STATUS: UPDATED

Freshness-Audit-Bericht — orgpulse

Geprüft am 2026-07-25 gegen den Codestand bis Commit 92f9e41 (2026-04-23).

Gefundene Abweichungen

  1. README.md, Abschnitt "Local build (self-hosted)" (vor Änderung Zeilen 97–102)
    Beschrieb nur "Screenshot diagnostics plus metadata analysis of SFDX projects", erwähnte aber zwei tatsächlich vorhandene, getestete Features des Local Builds nicht:

    • AI-generierte Fix-Vorschläge pro Finding (BYOK, Claude Haiku standardmäßig, Sonnet als Option) — verifiziert in src/metadata/fixSuggestions/fixSuggester.js, src/api/claudeClient.js, verdrahtet in src/ui/metadataSection.js.
    • Export aller Findings als Markdown-Report (Executive Summary + Detailed Findings) — verifiziert in src/ui/markdownExporter.js, Export-Buttons in src/ui/metadataSection.js:161,433.
      Beide Features stammen aus den Commits 8d76827, 6238211, f14bed5, 28ecb4f, c857c23, 99cf301, f16040f (alle 2026-04-18/19) und waren in keinem Dokument erwähnt.
  2. docs/architecture.md, Abschnitt "Module Structure" (Zeilen 45–58) und "Module Dependencies" (Zeilen 60–68)
    Der abgebildete Verzeichnisbaum listete nur src/js/{matrix,ocr,vision,settings,recommendations}.js und src/data/recommendations.json. Tatsächlich vorhanden und nicht abgebildet: src/js/validation.js, src/api/claudeClient.js, src/ui/{metadataSection.js,markdownExporter.js}, das gesamte src/metadata/**-Modul (Analyzer, Fix-Suggestions, File-System-Zugriff), sowie src/styles/metadata.css. Verifiziert per Verzeichnis-Listing (find src -type f).

  3. CHANGELOG.md, Abschnitt "[Unreleased]"
    Enthielt nur die ursprünglichen Bootstrap-Punkte (OCR, Vision-Integration, Matrix, Settings-Dialog, GitHub-Pages-Workflow). Von den 40 erfassten Commits fehlten sämtliche Einträge zu: Metadata-Analyzer (Apex/Flow/Roll-up/Workflow/Trigger-Duplikate), AI-Fix-Vorschläge, Markdown-Export, OCR-Kalibrierung/Diagnose-Panel, Sample-Screenshot-Button, UI-Politur (Severity-Farbcodierung, Tooltips, Kontext-Hinweise) sowie diverse Bugfixes. Dies wird auch von docs/REPO_REVIEW.md (Zeile 124, Stand 2026-04-19) selbst so festgestellt ("CHANGELOG.md is not maintained").

  4. .github/ISSUE_TEMPLATE/matrix_recommendation.md, Zeilen 9 und 25
    Beispieltext passte nicht zum tatsächlichen Produkt: Matrix-Zelle-Beispiel "High Growth / Low Engagement" existiert nicht — die neun echten Zellen heißen Quick Wins, Prioritize, Strategic, Take Along, Evaluate, Weigh Up, Opportunistic, Defer, Skip (verifiziert in src/data/recommendations.json). Tag-Beispiele adoption, engagement, governance, license-risk entsprechen nicht dem tatsächlichen Tag-Vokabular (Apex, SOQL, LWC, Integration usw., siehe docs/contributing-recommendations.md und recommendations.json).

Vorgenommene Änderungen

  • README.md: Zwei Bullet-Points zum Abschnitt "Local build (self-hosted)" hinzugefügt (AI-Fix-Vorschläge, Markdown-Export).
  • docs/architecture.md: "Module Structure"-Baum und "Module Dependencies"-Diagramm um api/, ui/, metadata/**, validation.js und metadata.css ergänzt.
  • CHANGELOG.md: Unter "[Unreleased]" fehlende Added-Punkte ergänzt (Metadata-Analyzer, AI-Fix-Vorschläge, Markdown-Export, OCR-Kalibrierung/Diagnose-Panel, Sample-Screenshot-Button, UI-Politur) sowie einen neuen Fixed-Abschnitt (OCR-Fixes, Recommendations-Matrix-Korrekturen) hinzugefügt.
  • .github/ISSUE_TEMPLATE/matrix_recommendation.md: Beispieltexte für Matrix-Zelle und Tags an das tatsächliche Produkt angepasst.

Alle Änderungen halten sich an vorhandenen Ton/Stil und wurden gegen den Quellcode verifiziert (Dateien gelesen bzw. per Grep geprüft).

Offene Punkte für manuelle Prüfung

  • ROADMAP.md: "Phase 0: Soft Launch (Current — Private Beta)" mit unerledigten Punkten [ ] Make repository public und [ ] Publish to GitHub Pages unter Phase 1. Mehrere Indizien deuten auf einen fortgeschritteneren Stand hin: die In-App-Badge wurde am 2026-04-20 von "Private Beta" zu "Beta" verkürzt (src/index.html, Commit 92bc5c1), deploy-pages.yml ist aktiv und deployt bei jedem Push auf main, und BACKUP_RESTORE.md beschreibt bereits am 2026-04-17 einen "Public GitHub Pages deploy working at https://rammc.github.io/orgpulse/". Ob das GitHub-Repository selbst inzwischen öffentlich ist, lässt sich aus dem Repo-Inhalt allein nicht verifizieren (ein Kommentar in deploy-pages.yml weist darauf hin, dass Pages-Deploys auch aus privaten Repos mit kostenpflichtigem Plan möglich sind) — daher keine Änderung vorgenommen.

  • README.md, Zeilen 7–8 (Badges): Der Linkcheck meldet leere URLs ([![...]]()) bei den Status- und License-Badges. Das ist vermutlich beabsichtigt (Badge ohne Klick-Ziel), könnte aber auch ein vergessenes Linkziel sein. Da kein verifizierbares Zielziel ermittelbar war, wurde nichts geändert.

  • README.md, Zeile 14 — https://dreamin.al/ (415 Unsupported Media Type): Wahrscheinlich ein Fehlalarm des Linkcheckers (WAF/Bot-Abwehr), keine inhaltliche Diskrepanz erkennbar. Nicht geändert.

  • README.md, Zeilen 176/178/179 — LinkedIn-Links (Status 999): LinkedIn blockiert automatisierte Crawler grundsätzlich mit Status 999; kein Hinweis auf tatsächlich tote oder umgezogene Profile. Nicht geändert.

  • docs/RECOMMENDATIONS_AUDIT.md, Kopfzeile ("24 Empfehlungen, 19 Signale"): Das Dokument selbst dokumentiert in seinem "Implementation Status"-Abschnitt 4 seither neu hinzugefügte Empfehlungen (Queueable Apex, API Rate Limiting, Concurrent Request Queue Management, Capacity Planning Review) — das würde 24+4=28 ergeben. Tatsächlich enthält src/data/recommendations.json derzeit 29 Empfehlungen (per Zählung der title-Felder auf Empfehlungsebene). Die Diskrepanz von 1 lässt sich mit vertretbarem Aufwand nicht eindeutig auf einen bestimmten Posten zurückführen (das Audit-Dokument selbst weist bereits intern eine Unstimmigkeit zwischen "25 Tabellenzeilen" und "24 Gesamtsumme" auf, siehe Zeile 96 des Dokuments). Empfehlung: manuelle Abstimmung durch den Maintainer, da dies ein historisches Audit-Dokument mit eigenem Datumsstempel (2026-04-18/19) ist und nicht unbesehen überschrieben werden sollte.

  • docs/contributing-recommendations.md, Abschnitt "Valid Signal Names" — "Derived signals": Die dort gelisteten Signalnamen (db_cpu_time, apex_execution_time, ui_request_time, slow_transactions, concurrent_requests, concurrent_dml, callout_time, error_rate, slow_soql, full_table_scan) tauchen in src/js/validation.js (Whitelist für Vision-Findings) nicht auf und werden auch sonst im Code nirgends als tatsächlicher finding.metric-Wert erzeugt. Empfehlungen, deren relevant_signals ausschließlich aus solchen "derived signals" bestünden, könnten dadurch nie als relevant markiert werden (siehe Matching-Logik in src/js/recommendations.js, filterRecommendations). Das ist potenziell eher ein Anwendungslogik-Thema als ein reines Dokumentationsproblem und wurde daher nicht am Dokument geändert — empfohlen wird eine Prüfung durch die Entwickler, ob diese Signalnamen tatsächlich erreichbar sind oder die Doku entsprechend präzisiert werden muss.

  • src/metadata/README.md, Abschnitt "Analyzers" (Zeilen 11–14): Listet nur apexCpuAnalyzer, apexRowLockAnalyzer, flowAnalyzer — der vierte, bereits registrierte Analyzer metadataAnalyzer (Roll-up-Summary/Workflow/Trigger-Duplikate, Commit f71549b vom 2026-04-23) fehlt. Diese Datei liegt außerhalb der Allowlist (src/** ist nicht durch docs/**, *.md (root-level) oder .github/**/*.md abgedeckt) und wurde daher nicht geändert.

  • src/public/samples/README.md: Nicht in der Allowlist enthalten, inhaltlich aber unauffällig — keine Änderung nötig, keine Prüfung möglich im Rahmen der Allowlist.

  • README.md — Badge-Text "public beta" vs. In-App-Badge "Beta" vs. ROADMAP.md "Private Beta": Drei unterschiedliche Formulierungen für denselben Projektstatus an drei Stellen. Da keine eindeutig "richtige" Bezeichnung im Repo verifizierbar ist (unterschiedliche Kontexte: Marketing-Badge vs. App-UI vs. Roadmap-Phase), wurde nichts geändert. Empfehlung: einheitliche Statusbezeichnung festlegen.


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 25, 2026
@rammc
rammc merged commit 1cb112d into main Jul 25, 2026
1 check passed
@rammc
rammc deleted the chore/freshness-audit branch July 25, 2026 18:25
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.

1 participant