Setup Guides
Vorbereitung von Verzeichnissen, Dateien und technischen Voraussetzungen.
Documentation / Guides
Documentation Guides
Guides übersetzen technische Ziele in nachvollziehbare, wiederholbare und prüfbare Arbeitsschritte.
ACTIVE DOCUMENTATION AREA
Praktische technische Anleitungen
Eine gute Anleitung beschreibt Voraussetzungen, einzelne Schritte, erwartete Ergebnisse, Risiken und eine abschließende Prüfung.
Documentation Components
Kernbereiche
Build Guides
Schrittweise Durchführung von Build- und Prüfabläufen.
Audit Guides
Anleitungen für lokale, siteweite und öffentliche Audits.
Deployment Guides
Kontrollierte Veröffentlichung und anschließende Live-Prüfung.
Troubleshooting Guides
Gezielte Analyse und Behebung technischer Fehler.
Release Guides
Wiederholbare Freigabeabläufe mit klaren Kontrollpunkten.
Dokumentationsgrundsätze
- Voraussetzungen vor den Schritten nennen
- Jeden Schritt eindeutig formulieren
- Erwartete Ergebnisse sichtbar machen
- Risiken und mögliche Fehlerquellen angeben
- Die Anleitung mit einer Prüfung abschließen
Datenquelle
Dieser Bereich verwendet gemeinsame, lokal validierte Documentation-Daten.
Qualitätssicherung
Dokumentationsseiten, JSON-Dateien, interne Links, Routen und Asset-Verweise werden vor der Veröffentlichung geprüft.
DOCUMENTATION