Neue Kategorie Dokumentationssupport
-
Ich habe versuchsweise eine neu Kategorie angelegt
In dieser Kategorie möchte ich das im Moment wieder etwas aktivere Geschehen rund um die Erstellung und Pflege der ioBroker-Anwenderdoku bündeln.Ob noch Unterkategorien kommen weiß ich noch nicht, und ob ich das gesamte Unterforum nach getaner Arbeit wider lösche auch nicht.
Im Moment möchte ich bitten eine Struktur durch Tags zu erzeugen.
Insbesondere User, die hier "hereinstolpern", weil sie zwar nicht an der Doku mitarbeiten, aber einen Hinweis, einen Wunsch, oder ähnliches haben, dieses deutlich mit einem Tag klar zu machen.(Das Ganze soll auch ein Test für ein anderes Projekt mit @Jey-Cee sein
)Bitte erzeugt so wenige neue Tags wie möglich
Anregung
Wunsch
Hinweis
vielleicht auch "Biete Hilfe" bieten sich in meinen Augen im Moment an -
Wenn @Homoran schon Tags erwähnt möchte ich euch noch auf die Hilfe dazu Aufmerksam machen:
https://forum.iobroker.net/help-german#tags-germanKann ja sein das jemand die Funktion noch gar nicht kennt.
-
@jey-cee sagte in Neue Kategorie Dokumentationssupport:
Wenn @Homoran schon Tags erwähnt möchte ich euch noch auf die Hilfe dazu Aufmerksam machen:
https://forum.iobroker.net/help-german#tags-germanKann ja sein das jemand Funktion noch gar nicht kennt.
Da fängt es schon wieder an. Hätte ich sonst gegooglet
-
@smarthome2020 sagte in Neue Kategorie Dokumentationssupport:
Hätte ich sonst gegooglet
wahrscheinlich aber nur wenn du noch nie einen Thread eröffnet hast.
Ansonsten läuft es so ab:
als 3. Schritt werden Tags eingegeben.
Je nach Kategorie musst du sogar welche eingeben und in der Spitze darfst du nur vorgegebene verwenden -
ich habe das markdown tool als server bei meinem email provider installiert - es braucht einen webserver mit php 7.4 (typemill) - wenn du das testen möchtest - gerne anydesk - ich kann dir auch einen account geben
eigentlich wollte ich es für meine eigene doku verwenden, da bin ich auch noch auf der suche - aber dieses tool scheint sehr gut zu sein - und selbst nur, wenn man den text darin vorbeireitet und dann nach github (iobroker9 kopiert (bezug markdown)
ich habe bis jetzt keine editor gefunden, der so einfach zu nutzen ist - der editor ist aber leider teil des ganzen server tools
zur doku erzeugung - ich habe einfach mal ein wenig gespielt und was mir aufgefallen ist - die doku sollte keine großen themen haben, sondern unterteilt werden
ein beispiel - alias gehört definitiv ganz am anfang erwähnt . wenn man jetzt nur einen unterpunkt alias erzeugt und darauf wartet, das jmd was reinschreibt, ist das extrem abstoßend - habe ich zumindest bei meinen tests entdeckt. erzeugt man aber unterpunkte z.b.
alias
- nutzung von alias
- alias mit formeln (dp verwandlung)
- alias als strukturgeber
- alias mit alias manger
- alias mit device manager
dann ist so die hemmschwelle viel niedriger für mich da etwas reinzuschreiben - man kann auch im forum, wenn die frage kommt gleich direkt die antwort in die doku schreiben und darauf verweisen (für die erfahrenen user)
müßte ich jetzt eine seitefür aliase schreiben - wäre zu viel - vergeht mir die lust - kann auch nur mein problem sein - weiß nicht wie ihr das sehtso ein tool wie screen2gif würde ich auch gut finden - man spart sich viel arbeit und zeit dabei und die gifs sind leicht einzubinden
-
@homoran sagte in Neue Kategorie Dokumentationssupport:
@smarthome2020 sagte in Neue Kategorie Dokumentationssupport:
Hätte ich sonst gegooglet
wahrscheinlich aber nur wenn du noch nie einen Thread eröffnet hast.
Ansonsten läuft es so ab:
als 3. Schritt werden Tags eingegeben.
Je nach Kategorie musst du sogar welche eingeben und in der Spitze darfst du nur vorgegebene verwendenEDIT: Mist, ich muss das Bild neu machen, hab den Threadtitel vergessen
Ach, habe ich doch . Hab nur gedacht, dass nun aus den von uns geschrieben Beiträgen die Schlagworte rausgesucht werden können. Bei neuen Threads kannte ich das schon.
Ich bin ansonsten generell für deutsche Worte in einem deutschen Forum. Verstehen meist 100% der Nutzer.
Ich weiß wie schwierig das ist . Hab da jeden Tag mit zu kämpfen, deswegen fällt es mir wohl auch so auf -
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
ur doku erzeugung - ich habe einfach mal ein wenig gespielt und was mir aufgefallen ist - die doku sollte keine großen themen haben, sondern unterteilt werden
so habe ich das mit der Doku zum admin gemacht
Hier noch die Knochen meiner alten Doku:
https://www.iobroker.net/#de/adapters/adapterref/iobroker.admin/README.mddort gab es dann "Überschriften" die die Namen der Reiter hatten und bei Anklicken auf die Unterseiten verlinkten
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
dann ist so die hemmschwelle viel niedriger für mich da etwas reinzuschreiben
dann ist aber nicht mehr alles "aus einem Guss"
ich muss natürlich dazu sagen, dass ich das immer noch aus den Augen des alleinigen Dokumentators sehe.
Die gesamte leere Struktur war ja für mich gedacht, da schnell Inhalte reinzubringen.
Nicht um andere abzuschrecken
Leider hab ich es nicht mehr geschafft
-
@homoran daher auch - je kürzer die absätze und unterpunkte sind, umso weniger merkt man , dass es verschiedene user sind
ob du als alleiniger admin und erzeuger damit glücklich wirst und das alles packst kannst nur du entscheiden und viel. sollte auch die community darüber ihr statement abgeben
evtl als alleiniger strukturverwalter - dann brauchst du zuarbeiter - und die würde ich direkt ansprechen - so wie in meinem beispiel mit dem alias: @paul53 fragen, ob er dir mal eine struktur gibt, wie man die alias sache richtig unterteilen könnte und wenn er dann lust hat, könnte er ein paar zeile nach lust und laune einfügen - sind es kleine abschnitte kann auch jmd anders ein paar sätze schreiben
ich könnte das z.b mit binding in der vis machen - wollte ich eh schon immer mal erzeugen , könnte ich auch gleich für die doku machen
- was ist ein binding
- wofür nutzt man ein binding
- binding im widget
- binding im script
außerdem sollten die erfahrenden user etwas darauf achten, was so gepostet und erklärt wird und dann evtl eine meldung oder gleich das ganze kopieren und einpflegen (oder du) - du kannst die "super-user" direkt im forum finden und mal ein nettes anschreiben verfassen, wenn du einen ablauf definiert hast und die struktur flexibler ist - keiner ist gezwungen, aber man sollte es im kopf haben! je öfter im forum dann auf die doku verwiesen wird, umso bekannter ist es
-
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
ob du als alleiniger admin und erzeuger damit glücklich wirst und das alles packst kannst nur du entscheiden
ich kann nicht mehr wie früher jeden Adapter installieren un djede Einstellung solange durchprobieren bis ich sie verstanden habe um sie zu erklären.
Und Dinge, die man nicht selber verstanden hat kann man nicht erklären.
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
evtl als alleiniger strukturverwalter
ich sehe den "Job" eher als "Chefredakteur".
Alleine schaffe ich das einfach nicht mehr, von der Menge und auch von den Anforderungen
Für die erste Doku als Github-Wiki habe ich erstmals mit Github gearbeitet, für die nächsten 3 habe ich mich in WordPress eingearbeitet. Aber mit dem jetzigen Konstrukt komme ich nicht klar - frag nicht warum, ich weiß es nichtWas ich will und für richtig erachte ist mir klar.
Und ich glaube die bisherigen Dokus hatten ihren Zweck erfüllt, warum also nicht diese jetzt
-
@homoran sagte in Neue Kategorie Dokumentationssupport:
Und ich glaube die bisherigen Dokus hatten ihren Zweck erfüllt, warum also nicht diese jetzt
ich glaube, darum geht es im moment nicht - die doku braucht def schreiber. wenn du die nicht findest, ist jede struktur sinnlos.
leider zeigt sich auch im moment, das keinerlei imput von den erfahrenden usern kommt - keiner gibt einen kommentar ab, was man wie brauchen würde , um die doku mit kleinen teilen zu füllen. da kannst du die struktur aufbauen, wie du willst - sie wird leer bleiben
wenn du lust hast, zeig mir mal, wie das einpflegen musst - anydesk ist immer aktiv
, heute, morgen , nächste wocheich kann mir im moment nicht vorstellen, was da für arbeit dahinter steckt, die sache zu füllen
wenn ich mir das anschaue - https://www.iobroker.net/#de/adapters/adapterref/iobroker.netatmo-crawler/README.md ist das die arbeit nicht wert - es muss klar werden, dass die user auf github gehen und nachsehen muss, was da steht - das alles nochmal in die doku zu kopieren, ist vergebene energie (pers. meinung von mir - kann man auch anders sehen)
-
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
da kannst du die struktur aufbauen, wie du willst
ich kann nichts mehr an der Struktur ändern, die ist bereits seit 2018(??) weitestgehend fest
@liv-in-sky sagte in Neue Kategorie Dokumentationssupport:
das alles nochmal in die doku zu kopieren, ist vergebene energie
deswegen wird das automatisch aus Github in die Doku eingepflegt.
So ist zumindest der Plan für die Adapterreferenz.Deswegen konzentriere ich mich jetzt auf den teil der unter dem Menüpunkt "Dokumentation" zu erreichen ist
-
@homoran sagte in Neue Kategorie Dokumentationssupport:
Deswegen konzentriere ich mich jetzt auf den teil der unter dem Menüpunkt "Dokumentation" zu erreichen ist
Hab gestern abend mal den Part node.js update überarbeitet (noch nicht ganz fertig, da Thema windows noch fehlt)
Generelle Verständnis-Frage
Was hat es mit dem Thread "was passiert hier" aufsich, bzw woher soll ich wissen/kann prüfen, ob nicht schon ein anderer ein Thema behandelt. -
@crunchip sagte in Neue Kategorie Dokumentationssupport:
Hab gestern abend mal den Part node.js update überarbeitet
DANKE!
@crunchip sagte in Neue Kategorie Dokumentationssupport:
Was hat es mit dem Thread "was passiert hier" aufsich,
den habe ich zur Erklärung wozu dieses Unterforum existiert erstellt.
Leider fiel mir kein passender(er) Threadtitel ein.@crunchip sagte in Neue Kategorie Dokumentationssupport:
woher soll ich wissen/kann prüfen, ob nicht schon ein anderer ein Thema behandelt.
Dann sollten wir/du jetzt dort einen Thread zum Thema node.js update (am besten mit Verlinkung der barbeiteten Seite) eröffnen und dies der Gemeinschat kudtun!
-
@crunchip ich war hier nicht präzise genug
@homoran sagte in Neue Kategorie Dokumentationssupport:
Dann sollten wir/du jetzt dort einen Thread zum Thema node.js update (am besten mit Verlinkung der barbeiteten Seite) eröffnen
Habe dich jetzt in die Arbeitsgruppen verschoben, auch wenn du (noch) eine 1-Mann-Gruppe bist
-
@homoran ja das mit dem
@homoran sagte in Neue Kategorie Dokumentationssupport:
dort
Hatte ich falsch verstanden.
Danke
-
@homoran Möchte mich auch an der Doku beteiligen. Hatte mir die Unterseite Repository schon einmal geschnappt und dort auch schon etwas bei mir vorbereitet.
Werde auch noch einmal den link prüfen den du mir geschickt hattest.Kann heute abend schon einmal einen Beitrag im Unterforum posten.
