Dokumentationsstruktur

Die zu FHEM verfügbare Dokumentation ist auf verschiedene Quellen aufgeteilt, deren Herkunft und Bedeutung gerade am Anfang nicht jedem bekannt ist.

Hier soll ein kuzer Überblick über die verschiedenen Quellen gegeben werden:

1. FHEM

Allgemeines zum FHEM sowie Installationsanleitungen.

2. commandref

Für die an der Entwicklung von FHEM beteiligten Softwareentwickler (Modulautoren) gibt es eine einzige verpflichtende Vorgabe: Offizielle Module müssen über eine englische CommandRef verfügen. Dies ist daher DIE wichtigste Quelle für Informationen rund um ein Modul. In der Regel ist diese sollte so gestaltet, dass mit dieser das betreffende Modul eingerichtet werden kann. Alle FHEM-Anwender sollten daher zunächst in der commandref nachsehen, wie Module oder FHEM-Befehle einzusetzen sind bzw. nach Lösungsansätzen für ihre Fragestellungen suchen. Auch neue Funktionen usw. werden hier in der Regel von den Modulautoren tagesaktuell dokumentiert.

3. a. Wiki

Die Artikel im Wiki stammen teilweise von den Modulautoren selbst, in der Regel werden diese jedoch von Anwendern für andere Anwender erstellt. Dementsprechend ist die Aktualität und Qualität der Artikel unterschiedlich. Für Verbesserungsvorschläge zum Wiki besteht ein eigener Bereich im Forum.

3. b. Forum

Im Forum stellen manche Entwickler, insbesondere auch solche (noch) inoffizieller Module, weitere Informationen zur Verfügung. Nützliche Infos zum Forum selbst sind in den angepinnten Beiträgen im Anfängerbereich zu finden, dort finden sich auch Hinweise zum Umgang mit der forumsinternen Suchfunktion.

4. Internet, Blogs usw.

Bei Informationen, die aus anderen Quellen stammt, sollte der Hilfesuchende selbst prüfen, inwieweit diese aktuell und von guter Qualität sind. Dabei ist zu bedenken, dass die betreffenden Autoren eventuell auch Interessen verfolgen, die nicht deckungsgleich sein müssen mit denen der FHEM-Community. Bevor man Fragen zu derartigen Informationsquellen im Forum stellt, sollte man diese gegen die innerhalb der unter 1-3 aufgeführten Quellen gegengeprüft haben.