Seminar Kroki – Teamstandards, Governance und Qualitätssicherung

Diagramme als gepflegte technische Artefakte organisieren

Textbasierte Diagramme lösen nicht automatisch Probleme mit veralteten Inhalten, unklaren Begriffen oder überladenen Darstellungen. Ohne Zuständigkeit und Review entstehen lediglich versionierte Inkonsistenzen. Das Seminar entwickelt deshalb ein praktikables Governance-Modell für Diagrammquellen und Ausgaben.

Zwei Tage sind notwendig, um Sprachkatalog, Benennung, Stil, Zugänglichkeit, Prüfungen, Freigabe und Lebenszyklus nicht nur zu beschreiben, sondern an realen Beispielen zu testen und als umsetzbare Richtlinie zu formulieren.

Inhaltsübersicht

• Zweck, Eigentum und Lebenszyklus von Diagrammen
• Freigegebener Sprach- und Einsatzkatalog
• Ordner, Dateinamen, Glossar und Metadaten
• Vorlagen, Stil und Abstraktionsregeln
• Fachliches und technisches Review
• Barrierefreiheit und geeignete Ausgabeformate
• CI-Prüfungen, Freigabe und Änderungsprozess
• Veraltung, Archivierung und Governance-Rollout

Zielgruppe

Das Seminar richtet sich an Architektur- und Entwicklungsteams, technische Redaktionen, Qualitätsmanagement, Plattformverantwortliche und Teamleitungen. Es ist besonders geeignet, wenn mehrere Bereiche Kroki nutzen oder ein gemeinsamer Diagrammstandard eingeführt werden soll.

Voraussetzungen

Erforderlich sind praktische Erfahrungen mit technischen Diagrammen und Grundkenntnisse der Versionsverwaltung. Ein kleiner Bestand eigener Diagramme oder Entwurfsrichtlinien unterstützt die Übungen. Tiefe Kenntnisse einzelner Sprachen sind nicht notwendig.

Lernstrecke Schritt für Schritt

1. Schritt 1: Diagrammzweck und Eigentum definieren. Jede Quelle erhält fachlichen Zweck, Zielgruppe, verantwortliche Rolle und Prüfrhythmus. Diagramme ohne Eigentum werden nicht als verbindliche Dokumentation behandelt.
2. Schritt 2: Einen Sprachkatalog erstellen. Freigegebene Sprachen werden ihren typischen Einsatzfeldern zugeordnet. Auswahlkriterien verhindern unnötige Werkzeugvielfalt und ungeeignete Universalnotationen.
3. Schritt 3: Ordner- und Namensregeln festlegen. Quelle, Ausgabe, Test und Begleittext erhalten stabile Pfade. Namen enthalten Zweck und Sicht, aber keine zufälligen Versionssuffixe.
4. Schritt 4: Ein gemeinsames Glossar pflegen. Systeme, Rollen, Schnittstellen, Zustände und Technologien werden einheitlich bezeichnet. Synonyme und Abkürzungen sind kontrolliert.
5. Schritt 5: Vorlagen und Minimalmetadaten definieren. Häufige Diagrammtypen erhalten Startvorlagen, Titelkonvention, Beschreibung, Eigentum und Aktualitätsangabe. Vorlagen bleiben klein und verständlich.
6. Schritt 6: Stil- und Abstraktionsregeln formulieren. Farbe, Form, Beziehungstexte, Grenzen, Detailmenge und Legenden folgen fachlicher Bedeutung. Design ersetzt keine klare Aussage.
7. Schritt 7: Fachliches Review aufbauen. Korrektheit, Vollständigkeit, Zielgruppe, Begrifflichkeit und Entscheidungsaussage werden von geeigneten Fachverantwortlichen geprüft.
8. Schritt 8: Technisches Review aufbauen. Syntax, Rendering, Dateistruktur, verbotene Zugriffe, Ausgabeformat und Buildfähigkeit werden automatisiert oder anhand einer Checkliste kontrolliert.
9. Schritt 9: Barrierefreiheit berücksichtigen. Kontrast, redundante Kodierungen, lesbare Schrift, Beschriftungen, alternative Texte und textliche Zusammenfassungen werden verbindlich eingeplant.
10. Schritt 10: Ausgabeformate standardisieren. SVG, PNG und PDF werden nach Zielmedium freigegeben. Skalierung, Dateigröße und Sicherheitsprüfung gehören zur Auswahl.
11. Schritt 11: CI-Prüfungen einrichten. Geänderte Quellen werden gerendert, Dateinamen geprüft und fehlende Metadaten gemeldet. Nicht reproduzierbare Diagramme blockieren die Freigabe.
12. Schritt 12: Freigabe und Änderungsprozess definieren. Pull Request, Reviewrollen, Ausnahmeverfahren und Veröffentlichungsstatus werden an die vorhandene Arbeitsweise angepasst.
13. Schritt 13: Veraltung und Archivierung steuern. Prüfdatum, Softwarestand und Eigentum machen überholte Diagramme sichtbar. Ersetzte Quellen werden nachvollziehbar archiviert oder entfernt.
14. Schritt 14: Governance schrittweise einführen. Pilotbereich, Schulung, Vorlagen, Messgrößen und Feedbackzyklen verhindern eine überladene Richtlinie ohne praktische Akzeptanz.

Praxisaufgaben

• Für einen Diagrammbestand Eigentum, Zweck und Prüfrhythmus zuordnen.
• Einen Sprachkatalog mit Einsatz- und Ausschlusskriterien erstellen.
• Eine überladene Grafik nach Stil-, Abstraktions- und Zugänglichkeitsregeln überarbeiten.
• Fachliche und technische Reviewchecklisten an einem Beispiel anwenden.
• Eine kurze Governance-Richtlinie mit Pilot- und Rolloutplan formulieren.

Kompetenzziele

• Verantwortung, Zweck und Lebenszyklus von Diagrammen verbindlich regeln.
• Sprachwahl, Benennung, Stil und Metadaten teamweit standardisieren.
• Fachliche und technische Reviews wirksam trennen und verbinden.
• Barrierefreiheit und Ausgabequalität in den Prozess integrieren.
• CI-Prüfungen, Freigabe, Archivierung und Governance-Rollout organisieren.