Validierungsebenen
Validierungsebenen sind die verschiedenen Wege, auf denen ein Projekt prüft, ob Implementierung, Dokumentation und Bereitstellungsartefakte noch den vorgesehenen Regeln und Qualitätserwartungen entsprechen.
Warum Schichten wichtig sind
Keine einzelne Form der Validierung reicht aus.
- Dokumentation allein erzwingt kein Verhalten
- Tests allein können die falschen Annahmen bestätigen
- CI allein kann nicht die Regeln definieren, die es durchsetzen soll
Ein mehrschichtiger Ansatz ist belastbarer, weil jede Schicht eine andere Form von Drift erfasst.
Gemeinsame Validierungsebenen
1. Spezifikation und Anleitung
Die erste Ebene definiert die Regel.
Ohne diese Schicht können spätere Prüfungen streng, aber willkürlich sein.
2. Manuelle Überprüfung
Die menschliche Überprüfung prüft Absicht, Randfälle und Produktbedeutung, die möglicherweise noch nicht automatisiert werden kann.
3. Lokale Validierung
Skripte und strukturierte Prüfungen erkennen schnell wiederkehrende Probleme, bevor Änderungen CI erreichen.
4. Automatisierte Tests
Ausführbare Tests überprüfen das erwartete Verhalten, jedoch nur, wenn sie mit der Spezifikation übereinstimmen.
5. CI-Tore
CI macht Prüfungen wiederholbar und für alle Mitwirkenden und Umgebungen sichtbar.
6. Bereitstellungsprüfungen
Bereitstellungsworkflows bestätigen, dass die erstellten Artefakte weiterhin veröffentlichbar und strukturell einwandfrei sind.
Wie sich die Ebenen verhalten sollten
Die Schichten sollten sich in dieser Reihenfolge gegenseitig verstärken:
- Dokumente und Spezifikationen definieren Erwartungen
- Die Überprüfung interpretiert diese Erwartungen im Kontext
- Validierungsskripte und Tests automatisieren stabile Teile der Überprüfung
- CI führt diese Prüfungen konsequent durch
- die Bereitstellung stellt sicher, dass die Ausgabe tatsächlich ausgeliefert werden kann
Gute frühe Validierungsziele
Beispiele für starke Frühkandidaten sind:
- Vorhandensein der erforderlichen Datei
- Vollständigkeit der Lokalisierung
- Syntaxgültigkeit
- Defekte interne Links
- Verbotene redaktionelle Zitate
- erfolgreiche Metadaten-Generierung
Diese Kontrollen sind in der Regel objektiv und kostengünstig.
Let Books Kontext
Das Let Books-Repository dokumentiert bereits mehrere Schichten, darunter:
- Produkt- und Implementierungsregeln in
AGENTS.mdundAGENTS-Implementation.md - Validierungsregeln für Entwicklung und Bereitstellung in
docs/Development.mdunddocs/Deployment.md - Redaktionelle Beweisregeln in
docs/blog/README.mdunddocs/sources/README.md - Lernleitfaden für die schrittweise Einführung von CI und Validierung
Das macht die Validierung zu einem dokumentierten System und nicht nur zu einem zukünftigen Ziel.