KNX/EIB Dokumentation der Gesamt-Funktionalität

[En3rGy]

Hallo zusammen,

wie dokumentiert ihr die Funktionen / Features, die euer Smart Home so bietet?
Welche Elemente umfasst eine professionelle Dokumentation?

Hintergrund ist der: Wie viele tüftele ich stetig am Haus und den immer komplexer werdenden Logikfunktionen (hier: HS). Natürlich frage ich mich,
- wie ich eine Dokumentation für die Nachwelt erstellen kann,
- was diese beinhalten und
- wie sie aufgebaut seien sollte, damit man dann etwas anfangen kann (z.B. ich in x Jahren)...

Viele Grüße

[GLT]

Einerseits die Schaltungsunterlagen (Schaltschrank, aber auch Topologie)
Die Applikationsbeschreibungen u. alle eingesetzen Org-Dateien der Geräte
Regelmässige, aktuelle Backups aus ETS, Experte usw. - für Geübte ist darin auch alles an Funktionalität dokumentiert

Funktionsbeschreibung im Klartext für den Laien - das ist meist das Aufwändigste, da schneller programmiert, als dokumentiert.

[concept]

Ich stimme GLT zu, in DEM BUCH sind noch wetergehende Vorscgläge zu finden (zB Dokumentation der Logiken), für die, die es ganz sauber für die Nachwelt hinterlassen wollen...

LG, Heinz

[En3rGy]

Funktionsbeschreibung im Klartext für den Laien - das ist meist das Aufwändigste, da schneller programmiert, als dokumentiert.

Wie kann so was sinnvoll aufgebaut werden?

Mein Ansatz sieht so aus:
- Organisation nach Gewerken (bei generellen Funktionen, z.B. Rollläden) oder Raumstruktur (bei Einzelfunktionen, z.B. Leselampe)
- Dokumentation aus Sicht des manipulierten Gewerks (Senke), z.B. das Verhalten der Rollläden wird im Kapitel Rollläden nicht im Kapitel Wetterstation
beschrieben
- Hinweis beim manipulierenden Gewerk (Quelle), z.B. Wetterstation steuert Rollläden, Heizung, ...

Am liebsten würde ich eine Art Steckbrief sehen, in der Geräte / Funktionen einheitlich beschrieben werden.

[Jever]

Ich stimme GLT zu, in DEM BUCH sind noch wetergehende Vorscgläge zu finden (zB Dokumentation der Logiken), für die, die es ganz sauber für die Nachwelt hinterlassen wollen...

Richtig, die Idee mit dem Zustandsdiagramm ist Klasse. Kann man für eine professionelle Doku mit der UML auch auf weitere Diagrammtypen ausweiten.

[En3rGy]

Ich stimme GLT zu, in DEM BUCH sind noch weitergehende Vorschläge zu finden

Oh, da habe ich wohl was verpasst
Was ist denn das BUCH?

[concept]

https://knx-user-forum.de/forum/öffe...-1-wire-und-co