Strukturierungsversuch Doku - Allgemein
-
@oliverio sagte: das dokumentation auch bestandteil der entwicklung ist
Das sollte sie sein, wird aber von Programmierern gern vernachlässigt.
-
@oliverio sagte in Strukturierungsversuch Doku - Allgemein:
@crunchip sagte in Strukturierungsversuch Doku - Allgemein:
So schnell wie die Entwicklung von Iobroker fortschreitet, kommt man da eigentlich kaum hinterher, das alles niederzuschreiben, geschweige denn aktuell zu halten.
ich kenne leute, die behaupten, das dokumentation auch bestandteil der entwicklung ist
das sollte definitiv für die Adapterreferenz so sein.
Bestandteil der Adapter und von dort in die Doku übertragen
Das ist auch der Hauptgrund warum die aktuelle Doku in Markdown ist. -
@crunchip sagte in Strukturierungsversuch Doku - Allgemein:
So schnell wie die Entwicklung von Iobroker fortschreitet, kommt man da eigentlich kaum hinterher, das alles niederzuschreiben, geschweige denn aktuell zu halten.
Klar es gibt Themen, die sind von genereller Bedeutung,
wie z.b. Was ist IoBroker, paar Grundeinstellungen, Grundbefehle, etc..
aber
gehts ans "eingemachte" bleibt man mit einer Beschreibung immer auf der Strecke
Das wir eine Never Ending StoryIch hätte daher die Doku auch vom "Groben zum Feinen" aufgesetzt. Die Themen die ich oben beschrieben habe legt man einmalig an und dann ist dort die Änderungsfrequenz eher gering.
Wenn ich mir die aktuelle Doku ansehe, dann ist bei einigen Seiten jedes Feld, jeder Button und jede Konfigurationszeile einzeln beschrieben. Das halte ich persönlich nicht für zielführend und wird darin enden, was du beschrieben hast, dass man nicht mehr hinterher kommt und es eine Never Ending Story wird.
-
@homoran sagte in Strukturierungsversuch Doku - Allgemein:
hättest etwas beitragen können
habe mich daran versucht
, bei Redis ,
aber man tut sich halt im allgemeinen sehr schwer etwas niederzuschreiben, wenn man nicht "vom Fach" ist.ich würde gerne mehr dazu beitragen,
hab mir immer wieder die "offenen" Punkte/ Platzhalter angesehen, überlegt/gerätselt was könnte man da rein schreiben, bzw was sollte da überhaupt rein.Aber dann irgendwie festgestellt, das macht so gar keinen Sinn, weil die Struktur einfach nicht passt, oder man beginnt mit einem Thema, beschreibt das näher, rutscht man automatisch schon wieder in einen anderen Bereich, der woanders besser aufgehoben wäre. Sprich, weil bestimmte Dinge "nahtlos" ineinander übergehen.
hoffe du verstehst was ich meine. -
@crunchip sagte in Strukturierungsversuch Doku - Allgemein:
hoffe du verstehst was ich meine.
sehr gut, weil ich auch
@crunchip sagte in Strukturierungsversuch Doku - Allgemein:
nicht "vom Fach"
bin.
Dier ersten beiden Dokus (github wiki, WordPress) habe ich ganz alleine nur durch trial and error sämtlicher Funktionen der damaligen Adapter geschrieben. Daraus dann auch die Installation und die ersten Tutorials.
@feuersturm sagte in Strukturierungsversuch Doku - Allgemein:
dann ist bei einigen Seiten jedes Feld, jeder Button und jede Konfigurationszeile einzeln beschrieben. Das halte ich persönlich nicht für zielführend
ist aber notwendig um einem Einsteiger zu helfen. Du weisst beim Schreiben nie, wo es bei jemandem anderen hängen wird.
Ganz aktuelles Beispiel https://forum.iobroker.net/topic/49338/doku-zu-datenpunkt-qualität/1@feuersturm sagte in Strukturierungsversuch Doku - Allgemein:
dass man nicht mehr hinterher kommt
Alleine die Screenshots für die jeweilige Adminversionen anzupassen war nachher schon ein Problem. Ich habe hier bestimmt schon wieder >100 Screenshots vorbereitet, als die nächste Versuon kam.
Da gibt es dann die Meldung im Forum: bei mir sieht alles anders aus!
und den Button hab ich nicht an der StelleAußerdem musste ich mich irgendwann entscheiden im Forum zu helfen (was IMHO auch eminent wichtig ist um dort das Feedback zu bekommen) oder täglich Stunden an der Doku zu schreiben.
-
Mal eine generelle Frage:
Ich selber habe Probleme in der Doku irgendetwas zu finden. Habe jetzt schon mehrfach gesucht in der Doku auf iobroker.net um die Konsolen-Befehle nochmal rauszusuchen um einen Adapter manuell zu stoppen oder bestimmte version zu installieren usw.
Bin ich zu blöd da was zu finden oder wie muss ich da suchen ? -
@segway suche und oder Filter auf der Seite benutzt?
https://www.iobroker.net/#de/documentation/config/cli.md -
@jey-cee
Ja klar habe ich alles gemacht. War klar dass es eine solche Seite gibt aber wie komme ich dahin ???
Ich gebe Konsole ein und kriege sowas hier und da ist nascht dabei:
-
@segway
bei mir klappt esaber das passiert, wenn content angelegt wird zu dem es keine Struktur gibt.
Da hätte auch die Struktur angelegt werden müssen. -
@segway ok der Suchbegriff liefert viel zu viele Ergebnisse, aber den Filter im Menü hast du nicht verwendet den der Liefert das gesuchte.
-
@homoran
Ja klar wenn man VORHER weiss dass man nach KONSOLENBEFEHLE suchen muss !
Das weiss doch aber niemand! Da gibt man nur Key Words ein wie Befehle oder Konsole / Console und dann kommt man damit NICHT zum Ziel.
Woher soll jemand Neues immer das Richtige Wort wissen um zum Ziel kommen ? -
@homoran Aber auch nur, wenn man den genauen Begriff eingbit. Wenn man nur "Konsole" eingibt, kommt eine erste Auswahl und unten "More 15 results ...". Klickt man hier drauf kommt man auf eine leere Seite
Auch wenn man den exakten Begriff eingibt, öffnet sich links der Baum nicht, so dass man nicht weiß, wo die Seite liegt
-
@feuersturm sagte in Strukturierungsversuch Doku - Allgemein:
Auch wenn man den exakten Begriff eingibt, öffnet sich links der Baum nicht, so dass man nicht weiß, wo die Seite liegt
das habe ich gerade auch gesehen, liegt aber IMHO daran
@homoran sagte in Strukturierungsversuch Doku - Allgemein:
wenn content angelegt wird zu dem es keine Struktur gibt.
Da hätte auch die Struktur angelegt werden müssen. -
@feuersturm sagte in Strukturierungsversuch Doku - Allgemein:
@homoran Aber auch nur, wenn man den genauen Begriff eingbit. Wenn man nur "Konsole" eingibt, kommt eine erste Auswahl und unten "More 15 results ...". Klickt man hier drauf kommt man auf eine leere Seite
Yep kann ich bestätigen !
-
@homoran sagte in Strukturierungsversuch Doku - Allgemein:
das habe ich gerade auch gesehen, liegt aber IMHO daran
@homoran sagte in Strukturierungsversuch Doku - Allgemein:wenn content angelegt wird zu dem es keine Struktur gibt.
Da hätte auch die Struktur angelegt werden müssen.Meinst du etwa diese Struktur?
-
@jey-cee sagte in Strukturierungsversuch Doku - Allgemein:
@segway ok der Suchbegriff liefert viel zu viele Ergebnisse, aber den Filter im Menü hast du nicht verwendet den der Liefert das gesuchte.
dann Muss ich mich korrigieren!
die Struktur existiert doch.Dann muss das im Framework korrigiert werden
Suche und Filter müssten ein Ergebnis bringen und der Menüpunkt muss aufklappen! -
@jey-cee bin nicht mehr am PC, hier im Bett am Handy bin ich nicht so schnell
und seltsamerweise tauchen einzelne Posts hier nicht sofort, sondern erst nach Minuten oder einem Refresh auf.
bist du per discord zugeschaltet? -
@homoran sagte in Strukturierungsversuch Doku - Allgemein:
Dann muss das im Framework korrigiert werden
Suche und Filter müssten ein Ergebnis bringen und der Menüpunkt muss aufklappen!Ne kann ich nicht bestätigen. Es kommt ein Treffer und wenn ich drauf klicke passiert nix bzw. leere Seite:
-
@segway sagte in Strukturierungsversuch Doku - Allgemein:
Ne kann ich nicht bestätigen
was?
@segway sagte in Strukturierungsversuch Doku - Allgemein:
wenn ich drauf klicke passiert nix bzw. leere Seite:
welcher Browser?
und <ENTER>? -
@segway Mit Firefox 94.0.1 (64-Bit) und Chrome 95.0.4638.69 (Offizieller Build) (64-Bit) springt die Doku zu der Konsolenbefehle Seite hin, wenn ich auf das Suchergebnis klicke.
@Homoran Enter bewirkt bei mir nichts. Ich kann auch mit dem Curser auch nicht auf das Suchergebnis gehen und dort das Suchergebnis per Enter bestätigen.
