Dokumentation

Home Automation macht Spaß. (Und ist praktisch und wichtig und energiesparend und überhaupt und ausserdem, sonst würden wir’s ja nicht machen.)

  • Dokumentation für uns selbst
    Gedankengänge – warum habe ich diesen Weg gewählt um jene Problematik zu lösen
  • Dokumentation zur Unterstützung für andere
    Wir sind kurzfristig nicht erreichbar, fallen krankheitsbedingt kurz aus – das System soll bedienbar bleiben, eventuelle Fragen beantwortet werden
  • Das System wird von jemandem anderen übernommen
    Aus welchen Gründen auch immer – wie kann ein Nachfolger sich möglichst schnell einarbeiten, wie kann er das System am Laufen halten, wo liegen die “Leichen im Keller”

Papier oder doch lieber digital?

Meine persönliche Meinung – beides.
Passwörter und Zugänge sowieso schriftlich in einem versiegelten Kuvert an einer vereinbarten Übergabestelle.

Aber auch eine kurze Mappe mit den wichtigsten Grundzügen ist im Falle des Falles für die meisten Menschen mit weniger Berührungsängsten verbunden als ein Zugang zu einem digitalen Archiv.

Nichtsdestotrotz plädiere ich bei einem hochkomplexen Smart Home für eine durchgängige exakte digitale Dokumentation, fein säuberlich an einem zentralen Ort geführt.

Für uns hat sich – nach langem Herumprobieren eine Mediawiki als das passendste Instrument herausgestellt. Siehe unten – wir haben auf WordPress umgestellt.
Jedes Thema bekommt eine eigene Seite, Gedankengänge werden ebenso dokumentiert wie Zugänge oder auch “lessons learned”. Ja, auch Fehlversuche gehören dokumentiert. Und eine FAQ ist ebenfalls eine exzellente Idee.

WordPress als Dokumentation

Wir haben die Mediawiki abgelöst. Sie war praktisch, aber Wartung und Updates waren – nennen wir’s mühsam.

Nach ziemlich langer Suche und vielen Testsystemen haben wir uns dafür entschieden, eine einfache WordPress Page als Dokumentationssystem zu verwenden. Warum ausgerechnet WordPress?

  • Pflege der Beiträge
    Auch für den Gelegenheitsbenutzer schnell und einfach zu bedienen,
    neue Beiträge können einfach angelegt werden,
    bestehende Beiträge problemlos editiert
  • Media Files
    Alle üblichen Medientypen können problemlos ins System integriert werden,
    Manuals und Screenshots werden zentral gepflegt und sind jederzeit zur Hand
    FileBird erleichtert uns die Strukturierung hier ungemein
  • Suche
    Relevanssi leistet hier gute Dienste – schnell, gut konfigurierbar und findet die gewünschte Info
  • Updates & Backup & Export
    Supereinfach zu handhaben!

Disziplin

Um als Dokumentation hilfreich zu sein ist es unerlässlich diese auch aktuell zu halten. Was sich zuerst nach Disziplin und Arbeit anhört wird im Laufe der Zeit zu einem netten Task, eine Art krönender Abschluß einer neuen Funktionalität.

Es hat sich ebenfalls bewährt auch Familienmitglieder mit der Aktualisierung der Dokumentation zu betrauen, dadurch sind sie im Fall des Falles mit den Werkzeugen vertraut und finden sich leichter zurecht.

Wie man im Bild nebenan sieht sind kleine Hilfsmittel ein weiteres nettes Spielzeug um die Dokumentation einfach und leicht up-to-date zu halten (kleiner 3D Barcode Scanner zB um HomeMatic IP Codes oder auch LoRaWan Codes zu scannen).

Ähnliche Beiträge

  • „Schatz, ich hab’ einen Admin-Account auf meiner Glühbirne!“

    Aus der Serie “Sätze die ich nie zu sagen vermutet hätte”. Ich hatte meine erste Philips HUE auf dem Schreibtisch war’ absolut verzaubert von der Idee per API direkt auf die Lampe zugreifen zu können. Das Einrichten des Zugriffs war…

  • LoRaWan

  • Bewässerungssystem ausblasen

    Es herbstelt, die Temperaturen fallen und es wird Zeit die Bewässerung einzuwintern – die Pumpen ausser Betrieb nehmen, den Kompressor in Stellung zu bringen und die Bewässerungskreise auszublasen. Und traditionellerweise wird das an einem regnerischen, kalten Samstagmorgen erledigt, immer am…

  • Gartenbewässerung

    Die Ausgangslage Bei der Übernahme des Grundstücks waren zwei voneinander getrennte Bewässerungssysteme verschiedener Hersteller vorhanden. Im Osten verrichtete eine Junior Max von Irritrol ihren Dienst, .. während sich im westlichen, etwas kleineren Bereich (kleiner vor allem deswegen weil da ein…

  • Eine Olive wird verkabelt

    Die Technik Die Temperatur wird mittels eines doppelten Temperaturfühlers nahe der Wurzeln und an der Oberfläche des Hügels erfaßt und per LoRaWan gesendet, die Heizung danach mittels HomeMatic IP geregelt (und auch die Leistung erfaßt). Sollte es überraschend in einem…

  • Home Assistant

    You’re At Home Baby!

    Genau dieses Gefühl hatten wir, als wir das erste Mal Home Assistant installierten.

    Es war einfach. Es war schnell. Es war übersichtlich und funktionell.