Technische Dokumentation "as-Code"
Hier findet sich die komplette Dokumentation und Anweisungen für die Installation, Konfiguration und Nutzung des Templates.
Versionierung
Das Template wird ständig aktualisiert, zuletzt am 5. Oktober 2022.
Idee
Das Ziel dieses Projekts ist die Bereitstellung eines einfachen Templates für das Schreiben von (technischer) Dokumentation während eines Projekts.
Übersicht
Die web-basierte Version des Betriebshandbuchs zeigt im oberen Bereich die einzelnen Sektionen.
Die Sektionen bündeln Kapitel zu dem entsprechenden Thema und dienen der besseren Übersichtlichkeit.
Das Hauptfenster ist drei-geteilt, auf der linken Seite sind die einzelnen Kapitel der Sektion zu finden, in der Mitte der Inhalt, auf der rechten Seite sind die einzelnen Unter-Abschnitte des derzeitig angezeigt Inhalts zu sehen.
Im oberen Navigationsbanner ist eine Suchfunktion implementiert, links daneben kann über eine Schieberegler die Dokumentation im Dark Mode angezeigt werden.