Autoren für die Doku, Wiki und Webdesigner gesucht

[cmalo]

Hallo,

wir brauchen in dem Projekt ein paar Personen die federführend die Dokumentation und das Webdesign unter smarthomeNG.github.io und im Wiki übernehmen.

Für alle Einsteiger und die, die schon immer etwas tiefer in smarthome.py einsteigen wollten aber nicht selbst programmieren wollen,
ist dies ein perfektes Subprojekt.

Tiefes smarthome.py Wissen ist nicht notwendig, aber man wird mit der Zeit auf jeden Fall ordentlich Wissen erlangen.
Zuarbeit ist garantiert.

Bewerbungen bitte ohne Gehaltsvorstellungen hier im Thread.

Danke und Grüße
Christian

[awknx]

Hallo Christian,

habe das hier gerade erst gesehen und dazu schon was geschrieben:

https://knx-user-forum.de/forum/supp...920#post936920

Die Gehaltsvorstellung "Wissensgewinn" würde mich reizen.

Viele Grüße
Andi

[elcoyotes]

Mich würde es auch reizen ein bisschen zu dokumentieren und ein bisschen am Webdesign zu schrauben.
Erfahrung in Sachen Programmierung, Webdesign etc. ist berufsbedingt vorhanden. Da ich jedoch begrenzte Zeitressourcen habe, fällt die Mithilfe bei der Programmierung flach (Zumindest in größerem Umfang). Aber immer mal wieder ein oder zwei Doku-Thema übernehmen, das sollte drin sein.

Ich habe selbst Smarthome.py und SmartVisu noch nicht am laufen, allerdings liegen der RasPi und das IP Interface schon hier rum und warten darauf angeschlossen und bespielt zu werden. Ich muss nur mal die Zeit finden.

Konkretere Pläne was gefordert ist wären hilfreich. Dann kann man auch gezielter sagen, wo man helfen könnte

[cmalo]

Cool, schickt mir mal eure Github Accounts per PM zu, dann bekommt ihr Schreibrechte auf das Webseiten-Repository.

Zu den Inhalten müssen wir uns noch ein paar Gedanken machen. Die Webseite sollte in erster Linie das Projekt präsentieren, dann Einsteigertauglich die Konfiguration und Plugins beschreiben.
Wobei es bei der Konfiguration und auch Installation sich einiges ändern wird. So viel Know-How wie das sh.py zurzeit erfordert um es zu installieren und zu konfigurieren ist meiner Meinung nach zu viel und kann so nicht bleiben.

Danke und Grüße
Christian

[schloessl]

Hallo Christian,

die Überarbeitung der Dokumentation ist lobenswert!
Vor 3 Jahren habe ich mich in smarthome und smartVISU hineingearbeitet und wurde nahezu von der Flut der Dokumentation erschlagen.

Ich hätte damals folgendes Wünschenswert gefunden:

Eine Art Homepage oder Wicki gegliedert entsprechen dem Verzeichnis z.B
Smarthome
etc
..
plugins
scenes
usw.

Darin wird der Inhalt der Gruppen erläutert. Zusätzlich wird jedes Element der Gruppe als Untergruppe aufgezeigt

in den Plugin / Fritzbox wird kurz der Sinn und Zweck in verständlicher Umgangssprache erläutert.
Nach dieser Erläuterung sollte sich ein Link zu einer vorgegebenen Seite im Supportforum befinden, z.b "Support_Fritzbox"
ein zweiter Link könnte dann auch auf "Support AVM" lauten.

Unter dem Thema "Support-Fritzbox" sollten dann auch alle Anfragen zum Thema rund um die Fritzbox einlaufen oder von den Admins hierhin verschoben werden. Leider leiden die Supportforen an der wilden Gestaltung der Überschriften. Manche Themen werden mehrfach unter verschiedenen Titeln behandelt.
Die Übersichtlichkeit sinkt, ja es gibt eine Suchfunktion! Aber wie ist der Suchbegriff zu definieren, wilde Abkürzungen oder nur Produktnummern müssen erst bekannt sein. Ohne Kritik, aber es gibt jetzt bereits 6 Chats zum Thema "Neue Version" , "der Weg zur 2.8" usw.

Unter einer geordneten Sruktur könnte sehr viel Wissen gesammelt werden. Der Anfänger braucht sich nur von letzten zum neusten Datum vorarbeiten und kann sich dann sicher sein, den aktuellen Stand einer Entwicklung zu kennen. Leider stehen heute Codesegmente in verschiedenen Beiträgen, das Tagesdatum des Beitrages lässt jedoch nicht erkennen wer auf welchen Stand zugreift.

Auch mein Vorschlag, Datum oder Versionsnummer iim Header der Soucedatei aufzunehmen, möchte ich noch einmal anführen.
Nennung der Versionsnummer bei Problemen hift auch dem Helfer. Nichr jeder Nutzer verfolgt täglich das Forum.

Vieles ist im Wicki hinterlegt, jedoch fehlt mir der Zusammenhang jeweils zum Forum.

Ich weiß, es ist eine Riesenaufgabe, aber mit ein wenig Disziplin aller Beteiligten könnte eine sinnvolle Dokumentation entstehen.

Wolfgang

[psilo]

bei den Plugins den Foren-Thread zu hinterlegen ist eine gute Idee, habe ich unter https://github.com/smarthomeNG/smarthome/wiki/AVM mal gemacht..

[schloessl]

Super psilo!
Du hast meine Gedanken verstanden und so fort umgesetzt. Ich hoffe Es werden weitere Entwickler und Supporter infiziert!

Danke fuer die tolle Demonstration meines Gedankenganges.

LG
Wolfgang

[psilo]

Wäre halt irgendwie gut, wenn wir für diverse Plugins hier "Spezialisten" hätten die helfen und dokumentieren. Aber der Kern geht wohl erstmal vor..

[psilo]

Hat jemand Erfahrung mit Sphinx? http://sphinx-doc.org/ Habe vorhin etwas damit herumgespielt und könnte ne gute Basis für ne gesamtheitliche Codedoku sein.. Aber ohne allzutiefes Wissen und nen vollen Tag für eine Einarbeitung, komme ich alleine aktuell irgendwie nicht in die Gänge...

[psilo]

Ich möchte das Thema nochmal aufgreifen. Wir finalisieren gerade das Backend-Plugin (Thread dazu folgt in Kürze) und aus meiner Sicht steht einem erstem Release bald nur noch die Doku "im Wege".

Wo sind denn die ganzen Freiwilligen die sich mal gemeldet haben? ;-) Wir haben jetzt sicher "netto" mehrere Tage, wenn nicht Wochen in die Entwicklung gesteckt. Es wäre daher super bei der Releaseabsicherung und bei der Doku nun auf Unterstützung zählen zu können.

[henfri]

Moin Psilo,

kannst du große Aufgabe vielleicht in überschaubare Häppchen aufteilen? Ich denke, dann finden sich leichter freiwillige.

Gruß,
Hendrik

[psilo]

Guter Vorschlag - und viell. liegt es bisher wirklich da dran, dass keiner mit jemand anders im Wiki in Konflikt kommen will, wir machen uns dazu mal Gedanken!

[psilo]

Hi,

also, aus meiner Sicht müssten wir einige Teile der alten Doku erstmal neu schreiben, insbesondere zu Items (wie erstellt man diese, was sind Standard-Attribute, eval, usw.).
Dazu habe ich jetzt mal unter https://github.com/smarthomeNG/smarthome/wiki/Items angefangen.
Daneben kann man sicher die Bereiche Logik und Plugins aufbohren. Wichtig ist, dass Anfänger wissen, was zu tun ist. Drum können das vermutlich sowieso auch Leute besser schreiben, die nicht so tief im Code stecken

Daneben müssen wir entwicklungsseitig ein: "was ist im neuen Release anders, was muss angepasst bzw. bedacht werden" schreiben, da sollten wir uns drum kümmern.
Ich fange mal eine Liste der Neuerungen an, die man dann ausschreiben kann.

VG,

René

[awknx]

Ich bin nach wie vor gern bereit da beizutragen, wenn mir also jemand einen Einstieg in das Wo, Wie usw. gibt, kann ich nebenbei jederzeit was machen (habe nur mit github usw. bisher null Erfahrung).

Viele Grüße
Andi

[betzs]

Für die Sphinx Dokumentation gibt es einen Pull Request.