Files
tibi-docs/plans/doku-pruefung-aktuell.md
T

6.8 KiB

Aktuelle Doku-Prüfung: tibi-server und tibi-admin

Stand: 2026-10-17
Umfang: tibi-server, tibi-admin-nova und die dazugehörigen Seiten, Screenshots und Prüfpläne in tibi-docs.
Ziel: Restlücken, Darstellungsfehler und konkrete Verbesserungen nachvollziehbar prüfen und abarbeiten.

Ergebnis in Kürze

Die Dokumentation ist umfangreich und deckt die zentralen Entwickler-, Betreiber-, Admin- und Anwenderabläufe ab. Die alten Auditlisten sind aber nicht überall auf dem aktuellen Stand: die Server-Systemrouten, Meta-Routen, Upload-Allowlist, Suchaggregate, Token-Scopes und Embedding-Gruppen sind inzwischen dokumentiert. Die Screenshots liegen überwiegend an der passenden Stelle. Zwei UI-Motive bleiben bewusst offen, weil sie sich mit dem erlaubten Mock-Projekt nicht erzeugen lassen.

„Alles erfasst“ lässt sich aus dem Coverage-Inventar allein nicht ableiten: Das Inventar ordnet 341 Elemente einer Doku-Seite zu, misst aber keine vollständige Verhaltenstiefe. Im aktuellen Report erreichen die Hook-Funktionen Stufe 4; Routen, MCP-Werkzeuge, Schemas, Komponenten und Test-Pläne stehen auf Zuordnungsstufe 2.

Befunde und Abarbeitung

Sprache und UI-Bezeichnungen

  • Startseite verwendete die unpersönliche „man“-Form. src/content/docs/index.mdx sagt jetzt „wie du damit baust“.
  • „Schnellsuche“ als UI-Name entfernt. Seitentitel, Überschrift und Querverweis heißen jetzt „Befehlspalette“. Der Suchbegriff bleibt nur als Alias in der Referenz.

Struktur und Prüfbarkeit

  • Lebenden Ausbauplan aktualisiert. Veraltete Screenshot-/Coverage-Zahlen, doppelte offene Pakete und alte Abschluss-Checkboxen wurden bereinigt; Umfang und Tiefenhinweis sind aktualisiert.
  • Struktur-Auditor präzisiert. Er sucht jetzt nach konkreten redaktionellen Markern, nicht nach legitimen Begriffen wie „Platzhalter“ oder „noch nicht“.
  • Coverage-Zuordnung als Zuordnung gekennzeichnet. plans/doku-ausbau.md trennt Mapping von vollständiger Verhaltenstiefe.
  • Embedding-Schema ergänzt. embedding.schema.json ist im Coverage-Inventar zugeordnet, in die generierte Property-Referenz aufgenommen und in der Schema-Liste als Serverkonfiguration eingetragen.
  • Schema-Zähler berichtigt. Der Generator und die ausgegebene Referenz nannten noch 16 statt 17 Schemas; beide Angaben sind nun konsistent.
  • Schema-Zähler in der Fähigkeitsmatrix berichtigt. Die aktuelle Liste nennt 17 Schemas einschließlich embedding; die historische Prüfnachricht vermerkt den alten Stand 16.
  • Stand des Ausbauplans aktualisiert. Die Kopfzeile nennt jetzt den aktuellen Prüftag.

Screenshots und Oberflächen

  • Bestand geprüft: Bilder unter assets/admin/ und assets/anwender/ liegen in den passenden Ordnern, haben Alt-Texte und sind kleiner als 200 KB. Keine UI-Aufnahme ist verwaist; Branding-Dateien sind keine Screenshots.
  • Platzierung korrigiert: Sieben Admin-Screenshots standen erst nach Fehlerabschnitten oder am Seitenende. Die sieben unterschiedlichen Dateien stehen jetzt bei ihren Themen: admin-filter-voice (Listenfilter/Mikrofon), admin-medien (Bildeditor), admin-exporte (Export-Dialog), admin-eintrags-editor (Pagebuilder-Editor), admin-ki-funktionen (Mikrofon im Chat), admin-benutzer-rechte (Benutzerverwaltung) und admin-customizing (eigene Exporte).
  • Offene Motive bewertet: Sitzungshinweis und Suchindex-Hinweisbanner bleiben als redaktionelle Notiz stehen, weil sie im erlaubten Mock-Projekt corporate nicht erzeugbar sind. Es gibt keinen Ersatz durch t1 oder erfundene UI-Zustände.
  • Mock-Änderungen berücksichtigt: Die Referenzseiten für Aktionen und Custom-Exporte nennen den corporate-Mock-Commit bff84be6. Die uncommittete Änderung an der Suchindex-Anzeige blieb unangetastet.

Abgleich mit den Quell-Repositories

  • Veraltete Audit-Befunde gegen den aktuellen Seitenbestand geprüft. REST-Systemrouten, _meta, Upload-MIME-Allowlist, Aggregation, Token-Scopes und Embedding-Gruppen haben aktuelle Dokustellen.
  • Aktuelle Arbeitskopie des Admin-Repos beachtet. SearchIndexBuildNotice.svelte ist lokal geändert. Die Änderung betrifft das Polling bei nicht verfügbaren Sammlungen; sie ist nicht Teil des Commits und wurde nicht überschrieben.

Arbeitsprotokoll

Punkt Ergebnis / Beleg
Quellstände tibi-server HEAD 88118b8e; tibi-admin-nova HEAD bff84be6. Admin-Arbeitskopie hat zusätzlich eine uncommittete Änderung an SearchIndexBuildNotice.svelte.
Coverage Inventar um die 16 unterschiedlichen System-CRUD- und Meta-Pfadformen erweitert; das bisherige setup.go-Inventar ließ die DB-API-Routen aus.
Coverage-Schema embedding.schema.json war das einzige nicht zugeordnete Schema; es ist nun server/konfiguration zugeordnet.
Abschlusstests Coverage 341/341, Schema-Generator 17 Schemas/167 Properties und idempotent, Build 71 Seiten, Doku-Audit 0 Findings.
Review Erstreview fand einen kosmetischen P2 zum Schema-Zähler; Generator und Ausgabe wurden korrigiert. Finalreview bestätigte danach keine offenen P1-/P2-Befunde sowie Screenshot-, Quellen- und Coverage-Angaben.
Server-Lücken gegengeprüft System-CRUD und _meta: reference/rest-system.mdx; Upload-MIME-Regeln: server/konfiguration.mdx; Aggregation: projekt/abfragen-lesen.mdx; Token-Scopes: projekt/rechte-tokens.mdx; Embedding-Gruppen: server/konfiguration.mdx und server/betrieb.mdx.
Screenshot-Bestand 67 Bildplatzierungen, 66 eindeutige WebP-Dateien: 17 Admin- und 49 Anwender-Bilder. Alle liegen im passenden Unterordner, haben Alt-Text und sind kleiner als 200 KB. favicon.svg und admin-nova.png sind keine UI-Screenshots. seiten-bloecke.webp wird in zwei passenden Abschnitten derselben Anwender-Seite wiederverwendet.
Screenshot-Platzierung Sieben unterschiedliche Admin-Bilder an die thematisch passenden Abschnitte verschoben. Listen-Mikrofon (admin-filter-voice) und Chat-Mikrofon (admin-ki-funktionen) sind getrennte Screenshots; Anwender-Bilder standen bereits neben den zugehörigen Schritten.
Offene Screenshot-Motive anwender/anmelden.mdx: Inaktivitätsdialog im Mock deaktiviert. anwender/lesen-suchen-filtern.mdx: Corporate-Mock hat keine Suchkonfiguration, die das Queue-Banner auslösen könnte. Beides bleibt als Kommentar markiert.

Abschluss

  • npm run coverage weist alle 341 inventarisierten Elemente zu.
  • npm run gen:schemas erzeugt 17 Schemas mit 167 Properties idempotent.
  • npm run build ist erfolgreich (71 Seiten).
  • node scripts/audit-docs.mjs meldet 0 Findings, keine defekten Links, Anker, Bilder, Tabellen oder MDX-Komponenten.
  • Änderungen wurden von einem unabhängigen Reviewer geprüft; keine P1-/P2-Befunde.