Wiki DE/EN nicht gleich

  • Hallo,


    mir ist im Wiki auf github etwas aufgefallen:


    1. Die Engliche Version ist Komplett in Deutsch
    2. Die Englische Version enhält mehr einträge als die Deutsche


    Wunsch:
    Als wunsch würde ich noch hinzufügen, dass man ein richtig wiki aufsetzt, wenn das möglich ist.
    Github finde ich nicht wirklich gut vor solche Zwecke.
    Für die Dokumentation der Config möglichkleiten usw ist es okay.


    Als beispiel würde ich gern das fhemwiki.de aufführen.
    Von User für User.


    Das Wiki würde ich aber nicht ohne Anmeldung über das Forum machen.


    Gruß Robert

    • Offizieller Beitrag

    grundsätzlich finde ich die Idee gut und es gibt auch ein passendes wbb plug-in:
    https://pluginstore.woltlab.co…de-lexikon-artikelsystem/


    Aber wer füllt das mit Inhalten (die auch aktuell bleiben)?


    Somit komme ich wieder zum Ursprung des Problems - die Entwickler (also ich) müssen diese Doku bereits beim programmieren erzeugen. Das ist der Hauptaugenmerk für DoorPi 3 mit dem Ziel, dass die Einrichtung und Konfiguration per Wizard in der weboberfläche durchgeführt wird. Alle dafür nötigen Infos müssen aus dem Quellcode selbst kommen. Die ersten Versuche dafür kann man hier sehen:
    https://github.com/motom001/Do…pi/resources/core/docs.py


    So sollen alle Module dokumentiert werden. In Verbindung mit der Internationalisierung kann das dann durch andere übersetzt werden.


    Wenn das steht, dann würde ich die Frage an euch stellen, ob ein Wiki überhaupt noch Sinn ergibt.

  • Du hast schon recht.
    Das Wiki fällt und steht mit der Aktualität.


    Jeder der Interesse hat kann es ja pflegen.
    Ich würde mich beteiligen.
    Ich finde ein Wiki besser als die ganze wichtigen info immer hier rein zum schrieben.


    Beispiel war bei meine Installation das Problem mit easy install.
    Laut Anleitung muss es nicht von Hand installiert werden.
    So hab ich es in den Thread gepackt und alle neuen müssen es bis zum Ende lesen um zur Lösung zu kommen. Oder Haupt Eintrags erstellen hätte es einpflegen müssen.


    Per Wiki hätte ich jetzt einfach hinzu gefügt und vermerkt das wenn nicht vorhanden wie folgt zu installieren ist.
    Dazu würde ich auch die config Einträge nicht mehr per github pflegen sondern per Wiki.
    dann kann man dir ganz/euch ganz einfach helfen.


    Bisher scheint aber nicht wirklich viel Interesse zu bestehen wie der Thread ja zeigt.


    Wie gesagt ich würde im Wiki gerne Hin und wieder was eintragen.
    Ist aber die Entscheidung des dev Teams.


    Wie du/ihr es wollt wird es gemacht.
    Ich werde auch gerne ein request im git schicken.


    Danke für eure Arbeit, ich finde das kann nicht oft genug erwähnt werden.


    Danke und Gruß Robert

  • Naja also der Sinn eines Wikis ist ja gerade der, dass es nicht zentral gepflegt wird, sondern verteilt durch die User- also zu deiner Frage wer füllt das und wer pflegt es- natürlich die User. Dass das gut funktioniert sieht man ja an diversen anderen Wikis.


    Ich denke im Wiki sollte auch nicht unbedingt die API Dokumentation stehen. Wenn die aus dem Quellcode direkt erzeugt werden kann, umso besser. Es sollten dort eher How-To's, also Anleitungen, Beispiele von Usern etc. stehen.


    Im Prinzip das was hier im Forum unter "Anleitungen" steht. Das Problem ist hier genau das der Aktualität- ein User schreibt mal die Anleitung, nach bestem Wissen und Gewissen. Nun stellt ein anderer User irgendwann fest dass die Anleitung nicht mehr stimmt, dass Informationen fehlen etc- jetzt müsste man den User der die Anleitung geschrieben hat kontaktieren, und der hat vielleicht gerade keine Zeit oder generell keine Lust mehr oder antwortet nicht- dann steht die Anleitung bis zum Sankt Nimmerleinstag falsch da oder bis einer der Admins hier die Änderungen eingelegt (-> Arbeit für die Admins).
    Daher bin ich der Meinung, genau sowas gehört ins Wiki und nicht ins Forum.

    • Offizieller Beitrag

    alle Einträge im Wiki sind von Supportern erzeugt wurden - die haben da schon viel Zeit investiert... An der Stelle noch einmal danke!
    Die Anleitung hier im Forum ist von mir und bestimmt schon 50 mal getestet. Deine Meldung habe ich gelesen und werde es testen bzw. nachstellen. Sollte es wirklich ein Fehler sein, werde ich die Anleitung korrigieren.


    Aber wie gesagt, eigentlich sollte die Anleitung funktionieren...


    Zur Beteiligung hier im Thread - viele lesen mit und halten sich aber zurück. Wenn es aber ums machen geht, dann sind erfahrungsgemäß einige am Start...


    // Edit \\


    Das Problem am wiki aus meiner Sicht ist, dass Informationen von jedem eingestellt werden können.
    Ob diese Information den richtigen / besten Weg beschreiben oder ob die überhaupt funktionieren ist nicht immer geklärt.


    Wie gesagt, ich bin grundsätzlich für ein Wiki, sehe aber noch nicht den enormen Vorteil.


    // Edit 2 \\


    Das Wiki auf github kann von jedem bearbeitet werden. Wer es anpassen, verbessern oder aktualisieren will, der darf gern loslegen.
    Da sich in doorpi 3 aber einige (grundlegende) Dinge ändern werden, bitte ich euch noch nicht so extreme viel Zeit zu investieren.


    @Joker mit Doku aus dem Quellcode heraus meine ich weit mehr als nur die API. Beim programmieren lege ich ja schon fest, welche Events und welche Aktionen ein Keyboard (zukünftig Interface genannt) bedienen kann und welche Parameter dabei mitspielen. Theoretisch ist auch jede Aktion einem entsprechenden Interface zuzuordnen. Auch die möglichen Konfiguration (mit Typ, default etc) werden beim programmieren festgelegt.
    Was natürlich nicht dabei ist, sind alle Themen rund um howto, best practices, showroom,...

  • Also ich habe sowohl im beruflichen wie auch im privaten Umfeld schon einiges mit Wikis und auch "Einführen von Wikis" zu tun gehabt. Aus der Erfahrung kann ich eigentlich folgendes sagen:


    Die Ängste, dass dabei falsche/unsinnige Informationen entstehen, sind unbegründet. Natürlich kann es mal vorkommen, dass für einen bestimmten Zeitraum eine fehlerhafte Information irgendwo steht. Aber die wird normalerweise relativ schnell korrigiert. Und man muss ja auch folgendes sehen: Auch Anleitungen, die direkt vom Entwickler kommen, müssen nicht zwangsläufig stimmen, und auch nicht zwangsläufig die beste Lösung sein. Denn auch der Entwickler hat eine gewissen Vorgehensweise die er sich angeeignet hat und "schon immer so gemacht" hat, aber es muss nicht unbedingt das beste sein. Außerdem ist ein Entwickler so tief in der Materie drin, dass für ihn bestimmte Sachverhalte klar sind, die für den "normalen" User nicht klar sind. So können Anleitungen entstehen, die für den Entwickler klar sind, für Außenstehende aber nicht.


    Der Nutzen, den man davon hat wenn User die Anleitungen schreiben und verbessern, ist wesentlich höher als die Gefahr dass mal irgendwo was falsches steht, das kann man nie verhindern. Auch die Aktualität der Anleitungen wird höher, denn immer mal wieder benutzt ein neuer User die Anleitung und stellt vielleicht ein durch geänderte Sachverhalte rein gekommenes Problem fest, und verbessert die Anleitung dann. Wenn nur einer die Anleitung betreut, dann kann er in der Regel auch nur Dinge ändern die sein persönliches Setup betreffen. Die Spannbreite wenn mehrere User bearbeiten, ist höher und somit die Qualität auch besser.


    Lange Rede kurzer Sinn: Keine Angst hier Verantwortung abzugeben, es lohnt sich. Ich kenne kein einziges Wiki-Projekt, was komplett den Bach runter gegangen ist.


    Dass das Github Wiki von jedem verändert werden kann wußte ich nicht. Werde ich mir mal ansehen. Aber ich denke es ist dann auch notwendig, zu definieren, welche Information wo hin soll. Ich bin z.B. der Meinung dass die Anleitungen hier im Forum in ein Wiki gehören (da sie so z.B. von mehreren Usern aktuell gehalten werden können).

    • Offizieller Beitrag

    ich will mich nicht quer stellen -
    - wenn ihr ein Wiki haben wollt und
    - es Leute gibt, die sich bereit erklären das auch zu pflegen, und
    - das github wiki nicht okay ist,
    dann sagt mir, was ihr braucht und ich kümmere mich.


    Wenn ein anderes wiki als auf github genutzt werden soll, dann würde ich das wbb addon von oben bevorzugen.


    Ich würde mir aber vorher einen Schlachtplan wünschen. Was soll wo stehen und wer pflegt wann welche Daten. Es ist vieles "historisch gewachsen" und eine klare Struktur würde jedem, Anwendern und Entwicklern, helfen.