Dokumentationssprache von SmarthomeNG im Wiki und den zugehörigen Plugins

[Boomer55]

Hallo zusammen.

Ich möchte hier gerne mal ein Thema ansprechen, welches mich schon länger im Zusammenhang mit SmarthomeNG beschäftigt. Nämlich die Wiki-Dokumentation welche mal auf Deutsch (bspw. Installationsanleitungen) und dann wieder auf Englisch (bspw. die ganzen "README.md" der Plugins) hinterlegt ist. (Zur Abgrenzung: Ich spreche hier nicht von den Kommentaren direkt im Quelltext welche in Englisch sicherlich sinnvoller sind.)

Ich bin zwar des Englischen in meinem beruflichen Umfeld durchaus mächtig, komme aber nicht aus der IT-Sparte (SmarthomeNG und Python ist für mich eher wie der "Eisenbahn"-Ersatz). Daher ist es für mich (und ich denke auch für andere) manchmal nicht so einfach, diesen Beschreibungen der Plugins zu folgen. Auch denke ich, dass derzeit der Großteil der Einsteiger, Anwender und Entwickler von SmarthomeNG aus dem deutschsprachigen Raum kommen. Würde es daher nicht Sinn machen auch alle Beschreibungen erst mal primär auf Deutsch und dann optional auf Englisch zu erstellen und zu pflegen? Die Durchgängigkeit in der Dokumentation wäre dadurch auch wesentlich besser.

Dies würde sicherlich auch zur Attraktivität von SmarthomeNG beitragen und mehr Leute (inkl. meiner Wenigkeit) aufgrund der niedrigeren "Einstiegshürde" zumindest mal zur Mitarbeit an der Dokumentation bewegen. Denn aus meiner Sicht gibt es zu diesem wirklich tollen Projekt derzeit echt keine Alternative. Daher auch von mir nochmals vielen Dank an die Entwickler und meinen größten Respekt.

Beste Grüße,
Markus

[Msinn]

Hallo Boomer55,

wir wollen die Anwender Dokumentation auf Deutsch zur Verfügung stellen. Entwickler Doku ist auf Englisch.

Ich habe im Wiki auf der Plugin Seite angefangen alles was es an Doku zu Plugins gibt zu verlinken.

Der von festgestellte Misch-Masch entsteht dadurch, dass es für die Plugins aus Doku häufig nur die vom Entwickler des Plugins geschriebene README.md Datei gibt. (mit höchst unterschiedlicher Qualität). Die README.md ist per Definition (bereits seit smarthome.py 1.0) in Englisch.

Dort wo es weitergehende Doku im Wiki gibt, habe ich auch diese verlinkt. Dort gibt es einen sprachlichen Mix, da der Autor in der ihm passend erscheinenden Sprache dokumentiert hat.

Die Anwender Dokumentation in zwei Sprachen zu pflegen werden wir nicht durchhalten können. Die Regelung Anwender Doku in Deutsch, Entwickler Doku in Englisch müssen wir noch konsequent umsetzen, auch wenn wir dabei evtl. eine Reihe Anwender verprellen, die der deutschen Sprache nicht mächtig sind. Außerdem müssen wir das Verständnis schärfen was Entwickler Doku ist und was Anwender Doku.

[Boomer55]

Hallo Msinn,

vielen Dank für die schnelle Antwort.
Das Argument mit der Pflege beider Sprachen ist natürlich klar. In diesem Fall kann ja die README.md in Englisch belassen werden.
Würde es aber Sinn machen, in der Übersicht der Plugins im Wiki eine Spalte mit dem entsprechenden Link zur Doku in deutsch einzupflegen?
Dann könnte jeder auf der entsprechenden Seite relativ einfach mitarbeiten und auch Beispiele einpflegen. Es müsste halt festgelegt werden, wo diese Seiten dann im Wiki hinkommen. Kann gerne mal was fürs Comfoair-Plugin versuchen wenn gewünscht.

[Msinn]

Eine extra Spalte ist aufgrund der geringen Breite der Tabelle nicht förderlich. Wo es Doku im Wiki gibt, ist die Beschreibung ein Link. Außerdem ist der Maintainer ein Link, wenn ein dedizierter Support Thread bekannt ist.

[Boomer55]

Danke noch für die Aufklärung.
Hab's grad im Wiki gesehen. Wer lesen kann, ist klar im Vorteil... ;-)

[NAlis75]

habt ihr einen Link zu diesem Wiki-Artikel?
danke

[Boomer55]

Hier der Link zur Beschreibung der Plugins und als Ergänzung noch der Link zur Wiki-Hauptseite von SmarthomeNG...

[NAlis75]

oh, super, vielen, vielen Dank