HTML-Dokumentation

von

in

Aufgrund der wachsenden Komplexität meines Heimnetzwerks habe ich mich an die Dokumentation der einzelnen Komponenten gemacht. Ziele der Dokumentation sind:

  • einen Überblick über die installierten Systeme zu behalten
  • die Anmeldeinformationen zu bündeln
  • die Installation zur Wiederherstellung zu beschreiben
  • die Fehlersuche zu erleichtern
  • das Backup sicherzustellen

Die Dokumentation ging in Word relativ flott von der Hand (16 Seiten), das Ergebnis sah aber recht bescheiden aus, insbesondere ist das Suchen und Hin- und Herspringen im .PDF oder .HTML Output mühselig. Also wollte ich es in HTML erzeugen. Da es nur für das Intranet gedacht ist, fällt WordPress auf dieser Website aus. HTML per Hand zu schreiben geht, sieht aber auch nur bescheiden aus (für meinen Weinbestand habe ich in Excel einen HTML-Generator geschrieben, der für diesen Zweck optimal ist). Früher habe ich kostenlose Versionen von Website X5 genutzt, auf Dauer war das aber zu umständlich. Jetzt habe ich das kostenlose RocketCake genutzt, die mitgelieferten Templates sind brauchbar und leicht anzupassen. Nur das Füllen von Tabellen ist mühselig. Die kostenlose Version erlaubt leider keine .CSS Anpassungen, also muss ich in den erzeugten Dateien hinterher einen Eintrag per Hand modifizieren, um die Menüleiste am oberen Rand festzumachen. Um nicht in die gleichen Probleme wie bei Website X5 reinzulaufen, muss ich den Installer von RocketCake gut aufheben, um auch in Zukunft Änderungen sicher machen zu können (die erzeugten .CSS und .HTML sind kaum zu pflegen).

Die Startseite des Raspberry Pi habe ich im Anschluss auch noch überarbeitet. In der kostenlosen Version von Rocketcake kann man zwar keinen PHP Code einfügen, es wird aber zumindest ein Platzhalter angelegt, den man anschliessend per Hand ergänzen kann. Das Ergebnis ist m.E. besser als die vorige manuelle Version.