Dokumentation zu Hause: Wie und womit?

[einstein2000]

Moin.

Ich habe gerade die nächste SPS ins Haus geschraubt.
Sie soll den Eigenverbrauch aus der PV-Anlage durch zuschalten von Lasten anheben - aber eigentlich ist das an dieser Stelle völlig ohne Belang.

Eine Frage, die mich daher aber seit geraumer Zeit beschäftigt: Wie dokumentiere ich solche Systeme für die Nachwelt?
Ich muss ja nicht mal vom Bus überfahren werden - schon ein längerer Urlaub an einem Ort mit wenig Empfang reicht, um erstmal Chaos auszulösen, wenn was wichtiges verreckt.
Die Menschen in meinem Umfeld bekommen üblicherweise eine Einweisung in die wichtigsten Funktionen, aber ich kann hier niemandem zumuten, sich jedes Detail zu verinnerlichen und für die eigene Vergesslichkeit ist eine saubere Doku ebenso viel Wert.
Mein (zugegeben vermutlich utopisches) ideales Ziel wäre eine Dokumentation, die z.B. einer Fachfirma einen schnellen Überblick gestattet und bei der Fehlersuche bestmöglich unterstützt.


Aus der Firma kenne ich Confluence, im Space nutzen wir ein Wiki-System.
Beides ist nicht unbedingt pflegeleicht und auch ein lokal gehosteter Server kann ausfallen, womit dessen Inhalt wertlos wird. Ins Netz stellen muss ich meine Netzwerkdoku aber auch nicht unbedingt.
Ausdrucken und abheften? Vermutlich eine gute Idee, aber die Pflege macht viel Arbeit.
Auch nimmt einem so ein Wiki-System viel Layout-Arbeit ab. Mit wenig Aufwand lassen sich übersichtliche Seiten mit Bildern, Querverweisen und Inhaltsverzeichnis generieren.

Ist das ein Problem, dass ihr für euch gelöst habt? Wenn ja, wie?
Ich bin absolut offen für alle Tipps und Ratschläge - gute Software oder ein Webdienst darf auch gerne Geld kosten.

Vielen Dank für euren Input und habt einen schönen Restfeiertag!

Viele Grüße,
Dominic

[Chemnitzsurfer]

Ich würde es zweigleisig machen
1) ausgedruckte DIN A4 Seiten möglichst idiotensicher geschrieben mit Screenshots von Menüs etc. die mal ggf. wer in deiner Abwesenheit öffnen muss einlaminiert im Sicherungskasten oder einer anderen Stelle hinterlegen, wo die nicht mal eben aufgeräumt werden.

Also so in der Art Fehler => Lösung wie es teilweise in tabellarischer Form in BDA anzutreffen ist

Bsp.

Code: Alles auswählen

Fehler :
Duschwasser ist kalt 

Mögliche Ursachen /Behebung 
x Heizung ausgeschaltet => großer beleuchteter Schalter an Heizung auf ein? Sicherung "Heizung" in Ordnung? (Hebel nach oben) 
x Zirkulationspumpe läuft nicht => Leuchtet das Display an der Pumpe?  wenn nein ...

usw.

Dazu noch eine richtige technische Dokumentation, am besten auch ausgedruckt in einen Leitzordner im Technikraum mit
Anlagenschema , wo zugeordnet werden kann was wo verbaut ist (Alle Feldgeräte, Schaltschränke etc. bitte eindeutig beschriften)
Topologien von BUS Systemen (z.B. RS486 Schnittellen vom Stromzähler, Wechselrichter und SPS)
ausführlichen Schaltplänen aller Anlagen
ausführliche Funktionsbeschreibung ,wie sie im gewerblichen Bereich (GLT, GA) üblich ist
https://www.potz-gebaeudeautomation.de/ ... nnen-muss/


Wichtig KISS Prinzip!
Lieber in Papierform, als auf ner NAS , wo der Mitarbeiter der beauftragten Firma nicht drauf kommt, weil deiner Frau das Passwort entfallen ist.

[Torpert]

Ich nutze https://obsidian.md/

Das läuft als lokale Software und legt die Daten lokal ab (die kann man dann bei Bedarf irgendwohin syncen). Ich habe das ausgesucht, weil es kein proprietäres Format nutzt und auch keine Datenbank. Alles ist in Dateien abgelegt und man könnte darauf auch ohne die Software noch einigermaßen sinnvoll zugreifen. Editiert wird in Markdown und es gibt sehr viele Plugins, die teilweise sehr nützlich sind.

Datensicherung landet (u. a.) auf einer externen Festplatte, die ich 1x im Jahr ins Bankschließfach bringe und gegen die Vorgängerplatte austausche. Dabei liegt ein Zettel mit den allerwichtigsten Zugangsdaten und Vorgehensweisen. Unsere erwachsenen Söhne haben eine Schließfachvollmacht und wissen, dass sie im Fall der Fälle dort alles finden.

Wichtige Sachen, die sich nicht mehr (oder kaum noch) verändern, liegen zusätzlich ausgedruckt an passender Stelle (z. B. die Dokumentation der Heizungssteuerung)

[Desinfector]

Also alles was sich nicht grossartig ändert
wie die Bedienung ausdrucken.
Heutzutage musste ja damit rechnen, dass Standards über mehrere Betriebssysteme nicht eingehalten werden und Dinge dann nicht bedienbar oder lesbar sind.

[nero]

habe dafür einen Ordner "Haus" auf NAS auf den alle Zugriff haben.

Dort dann nochmal sehr wenige Unterordner.
Da liegt dann rum was grad passt: txt Files, pdfs, csv, Bilder (mMn das wichtigste, va bei verlegten leitungen), zT auch SW, z.B. ein apk zum steuern unseres Saugroboters.

[Wobbel]

ich dokumentiere das wie fast alles was ich mir langfristig merken will mit Vimwiki der ein zigste harken ist die eingebundenen Bilder kann man sich dann erst im html Export ansehen. Und wenn dan ein Projekt abgeschlossen ist und andere Leute auch zugriff drauf brauchen drucke ich es meist aus und kommt in den entsprechenden Ordner.

https://vimwiki.github.io/

[Wurstjesus]

Ich lege, gemäß einer Empfehlung aus dem Buch "Der pragmatische Programmierer" (Original: Pragmatic Programmer), alles in Textdateien im Markdown-Format ab.

Dafür nutze ich ein privates Github repo, in das ich einfach .md Dateien schiebe. Der Vorteil für mich ist, dass ich aus dem Gihub webinterface schnell mal was anpassen kann, da markdown eben ein sehr rohtext-freundliches Format ist.

Da ich wenige Bilder für Dokumentation benutze, ist das eine praktikable Lösung. Die Bilder kann man in Markdown einbinden, zur Ansicht IN der Datei benötigt man dann allerdings wieder einen Markdown-Viewer.

Das Github-Repo kann man dann bei Bedarf an externe Firmen teilen (die das dann mit entsprechenden Berechtigungen sogar editieren könnten) bzw. gezippt herunterladen und per Hand verschicken. Falls bei mir alles abfackelt, liegts halt bei denen. Abwägungssache, ob man seinen Code bzw. Doku in Übersee liegen haben will. Ansonsten gibt es sicherlich auch deutsche git-hoster.

[caprivi]

viewtopic.php?p=326211#p326211

Grüße, caprivi