yaVDR-Dokumentation verbessern: Wer macht mit?

  • :heuldoch :uglyhammer


    mal sehen was er zauber und was nicht :D vielleicht sollte man einfach 2gleisig fahren. ein handbuch und ein wiki. welches die gleichen textschnipsel verwendet.


    ich finde handbücher generell besser zu lesen als ein wiki auch auf einem bildschirm!


    Naja, Entwickler brauchen ihre eigene Doku ja nicht ubbedingt selbst zu lesen, egal ob im Wiki oder Bildschirm. Es geht ja um die Nutzer, die die Doku lesen müssen.


    Ich gebe nochmal mein "Abschluss"-Statement zum sinkenden Schiff Wiki ab. :D


    Mein wichtigstes Argument für ein Dokumentieren in einem Wiki ist, dass es eine recht unkomplizierte Autorenumgebung für erfahrende yaVDR-User bietet, die etwas festhalten wollen. Jemand, der Schreiberfahrung hat und der etwas an Doku beitragen will, kann beim Wiki schnell etwas "droppen" und muss keinerlei Software lokal installieren und sich nicht mit Versionierungssystemen auseinandersetzen.


    Insofern erscheint mir der Kompromiss überflüssig, die Doku im Nachhinein in das Wiki zu importieren, weil das Wiki dann nur noch als Präsentationsmedium und nicht als Autorenumgebung genutzt wird. Der Aufwand lohnt dann nicht. Es gilt auch die Verdoppelung von Doku an verschiedenen Orten zu vermeiden (abgesehen von Übersetzungen).


    Wichtiger als jede Technologie ist aber, dass überhaupt jemand etwas schreibt. Hier ist seahawk ja momentan ein leuchtendes Vorbild. Meine geheime Hoffnung war und ist, dass ein frisches (=leeres) Wiki mit modernem Erscheinungsbild und modernen Extensions eine Reihe von Leuten motivieren würde, sich dort zu beteiligen und zu dokumentieren.


    Wenn nun seahawk - meinen Tagträumen entsprechend - das leere Wiki mit attraktivem Inhalt füllen gewollt hätte, war meine Hoffnung, dass er damit andere motiviert, mitanzupacken - mich inklusive: Ich habe mich ja seit 2009 dreißig Stunden mit Mediawiki und den Semantik-Sachen auseinandergesetzt, habe aber seit März eigentlich nur noch yaVDR-Doku im VDR-Wiki geschrieben und nicht mehr am yaVDR-Wiki weitergemacht, weil bisher alle meine Versuche, langfristig motivierte Autoren zu finden, gescheitert sind.


    Nun haben wir aber mit seahawk momentan jemanden, der anscheinend nicht von außen motiviert zu werden braucht (hoffentlich hält das lange an! :) ), der sich aber in der Autorenumgebung Wiki nicht wohlfühlt. Also soll er es halt in Asciidoc machen und dafür sorgen, dass eine möglichst unkomplizierte Möglichkeit existiert, an der Doku mitzuarbeiten - sprich Asciidoc-Quelltext ins yaVDR-Git, Autoren schicken dann Pull-Requests an den Maintainer. Damit wird aber die Hemmschwelle, an der Doku mitzarbeiten, für viele Community-Mitglieder erhöht. So sei es dann.


    Inhaltlich wäre auch folgende Splittung der Doku denkbar:


    Diejenigen Kapitel der Doku, die nur teamnahe Entwickler schreiben können, kommen in Asciidoc.
    Dienjenigen Teile der Doku, die auf User-Erfahrungen und User-Hardware basieren, kommen in das leere Wiki (also Hardware-Datenbank, VDR-Bauvorschläge, etc.). Und dann verlinkt man sich gegenseitig.


    Aber: Weil sich bisher eh keiner für die Semantik-Geschichten interessiert hat außer mir, ist das dann mein nächster Wunschtraum, der unerfüllt bleibt. :D


    Und nun: Ich wünsche gutes Gelingen mit Asciidoc und Git!


    Gruß
    hepi

  • Im Prinzip bräuchte man nur einen Server mit Python, das aktuelle asciidoc-Paket und ein Skript das mitbekommt, wenn sich am GIT was ändert, die Dateien holt und dann das ganze baut.
    Für das exportieren nach HTML wie es aktuell bei mir lokal läuft reicht dann ein Einzeiler in einem Skript, das Bauen ist auf einem Kern eines Core i5 2500 in einer Natty-VM in ein paar Sekunden erledigt.

    Code
    python /Pfad/zu/asciidoc/asciidoc.py -a data-uri -n -a icons -a lang=de -a toc2 -a toclevels=5 -a theme=flask -o "$OUTPUT" "$INPUT"


    hepi: Ich finde das mit der Semantik-Erweiterung fürs Wiki schon sehr spannend, vor allem bei Hardware-Kompatibilitätslisten und Softwareversionen haben deine Beispiele ja schon sehr schön gezeigt, was möglich ist. Wenn das yaVDR-Wiki mal so gut ausgearbeitet und benutzbar ist, dass sich auch unerfahrene Nutzer herantrauen und es auch nutzen kann man sich sicherlich auch gute Wikiartikel in die Doku übernehmen und umgekehrt (vieles in der Doku dürfte ja recht statisch für eine yaVDR-Version werden). Momentan mangelt es einfach generell an Inhalten und für Nur-Text-Seiten wie http://vdr-wiki.de/wiki/index.php/YaVDR-Webfrontend ist es praktisch egal, ob die gerade als asciidoc oder in Mediawiki-Syntax vorliegt, da muss man vielleicht 10 Zeilen anpassen, damit die Formatierung im jeweils anderen Format stimmt.

    yaVDR-Dokumentation (Ceterum censeo enchiridia esse lectitanda.)

  • @seahawk: Da finden wir einen Weg.


    Ich werde mal zusehen, dass ich die gerade bei mir aktive "Energie" bzgl. User-Hardware-Datenbank im Wiki jetzt produktiv nutze. Ich werde das mal ins Heidelberger Usertreffen tragen - morgen Abend. :D


    Gruß
    hepi

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!