yaVDR-Dokumentation verbessern: Wer macht mit?

Zitat

Original von Wicky
gda
In dem Zusammenhang: Ich habe den Eindruck, dass das System yaVDR mittlerweile einen (so guten) Stand erreicht hat, bei dem eine weitere Entwicklung die Dokumentation in stärkerem Maße berücksichtigen müsste und nicht mehr so sehr die technische Seite.

yaVDR ist im wesentlichen Lustgetrieben und nicht mit dem primären Gedanken an den Dienst für die Gemeinschaft. So sehr du damit auch Recht haben magst, ich fürchte es wird sich keiner im Team finden der darauf Lust hat eine Doku zu schreiben.
Aktuell haben wir einfach einen viel zu großen Spass daran, im unstable Bereich wieder alles kaputt zuspielen, mit so spannenden Dingen wie dem Dynamite-Plugin und im Bereich der Fernbedienung alles auf den Kopf zu stellen mit eventlirc.

Gerald

Zitat

Original von Wicky
Wenn jemand um die Ecke biegen sollte, der fähig und willens ist die Doku voranzutreiben, dann lasst uns alle demjenigen kräftig auf die Schulter klopfen....

Mir ist die Dokumentationsfrage auch wichtig. Aber sie ist nicht einfach zu beantworten.

Es geht nicht nur um:
1) Wo bleibt mehr Dokumentation? Wer hat genug Schreibwut?

Sondern auch um:
2) Wo soll die Dokumentation platziert werden, damit sie leicht und übersichtlich zu erreichen ist?
3) In welcher Sprache soll die Dokumentation geschrieben werden? Über [EDIT] 47%[/EDIT] der Besucher unserer Website sind internationale User, die kein Deutsch sprechen. [Meine persönliche Meinung war und ist bisher immer gewesen: Warum die 10. VDR-Doku auf Deutsch schreiben und damit die Standards von Open Source Software wieder einmal ignorieren? Auf der anderen Seite gibt es nur sehr wenige Autoren unter uns, die beide Sprachen beherrschen und der Aufwand, eine englische Doku aufzubauen, ist viel höher.]
4) Lässt sich die Dokumentation mit schon bestehender VDR-Dokumentation verknüpfen? Worauf kann man aufbauen?
5) Wer ist die Zielgruppe der Dokumentation?
a) Leute, die noch nie einen PC mit Linux daheim genutzt haben.
b) Leute, die Ubuntu regelmäßig nutzen, aber noch nie einen VDR genutzt haben.
c) Leute, die VDR genutzt haben, aber noch nie einen HD-VDR mit HDMI gebaut haben.
6) Wie stellt man sicher, dass die Doku konsistent bleibt und nicht über längere Zeit zerflättert?
7) Kann man so eine Arbeit in einem Doku-Team verrichten, welches sich nicht aus yaVDR-Developern zusammensetzt, mit einem Team-Koordinator aus dem yaVDR-Dev-Team? Wie lässt sich die Kompetenz und Erfahrung der langjährigen VDR-Portal-Nutzer für so etwas gewinnen?

Gruß
hepi

P.S.: Als yaVDR-Subforum-Moderator kann ich Titel dieses Threads ändern und auch den Thread auseinanderrupfen, wo er thematisch abdriftet. Wenn ich das tun soll, bitte ich um konkrete Vorschläge.

kleiner einwurf:

wichtiger als die doku wäre imho eine release note zu den ständigen verbesserungen. (die ich extrem gut finde.)

mein vorschlag: unter yavdr.org zusätzlich zum blog vielleicht noch einen bereich release notes erstellen und dort in knappen stichpunkten aufzählen, welche patches gerade in stable einfließen.

und als sahnehäubchen einen status, ob man updaten kann oder gerade wieder was hochgeladen wird.

dafür wurde dieser ja mal gestartet.

Zitat

Original von Wicky

Diese Antwort hatte ich befürchtet, da ich es selber gut genug kenne, dass in Projekten häufig mehr die "Coder" als die "Dokumentierer" zu finden sind.
Dennoch finde ich es richtig, dass Ihr euch von diesem Umstand nicht unter Druck setzen lasst. Nichts wäre schlimmer als wenn Ihr die Lust an eurem Tun durch Nörgelei verlieren solltet. Damit wäre niemandem geholfen !!
Ich hoffe meine Einschätzung wirkt nicht wie Nörgelei...

Nicht die Spur Wicky.

Zitat

Original von Wicky

Wenn jemand um die Ecke biegen sollte, der fähig und willens ist die Doku voranzutreiben, dann lasst uns alle demjenigen kräftig auf die Schulter klopfen....

Da wären wir alle dabei, aber nicht zu doll, er soll ja noch schreiben.

Allerdings wird hier etwas außer Acht gelassen, dass der Bernie7 schon großes geleistet hat. Auf seiner Homepage wird man fast immer fündig. Auch das Thema, dass ich heute erwähnt habe, kann man dort finden. Er widersetzt sich allerdings unseren Anwerbeversuchen als Hausdokumentierer standhaft.

Gerald

@yavdr-team: bernie7 wird euch doch bestimmt nicht verklagen, wenn ihr auf seine seite verlinkt. oder?

Bernie ist ja schon vor langer Zeit in sehr teamnahe Kreise aufgenommen worden, in der Hoffnung, wir könnten ihn bestechen und ihm Honig um den Bart schmieren, seine gute Doku zum Grundstein der offiziellen Doku auszubauen. Die Erlaubnis, seine Doku zu verlinken, haben wir schon lange.

Zitat

Original von Wicky
hepi
Für eine gute Vorlage für die yaVDR Doku halte ich die Seiten unter http://wiki.ubuntuusers.de/Startseite

Dort werden u.A. folgende Aspekte berücksichtigt:

- Format: wiki bzw. Inyoka (siehe http://ubuntuusers.de/inyoka/)
- Aktualität bzw. Relevanz durch Angabe der Gültigkeit für bestimmte Versionen

Alles anzeigen

Die verlinkten Wikiseiten sagen mir persönlich auch sehr zu. Ich habe mich eine Zeitlang auch schon mit Wiki-Systemen befasst auf der Suche nach einem System, welches elegant mehrsprachige Seitenversionen anbietet. Ich bin ein bisschen dickköpfig, was die Dokumentation angeht. Wenn, dann will ich es "richtig" machen, und richtig beinhaltet für mich immer, dass Raum für eine englische Version schon von vorn herein eingeplant ist. Meine Meinung dazu kann man hier nachlesen:

A multi-language VDR wiki: Does it make sense?

Und zum Motivieren von zukünftigen Dokumentatoren ist dieser Thread sehr gut geeignet:
Projektvoschlag: "VDR-Portal/Wiki technisch und inhaltlich runderneuern, Benutzerführung verbessern"

Gruß
hepi

Wie wäre es, wenn man es so handhabt wie auf http://www.ubuntu-forum.de/ ? Denn die haben ein WIKI eingerichtet, wo jeder seine Erfahrungen mit seinem System verfassen kann. Dieses kann man dann unterteilen nach Hardware, ob diese dann auch mit Linux läuft und wie diese denn auch konfiguriert wird.

Zitat

Original von Tuxi70
Wie wäre es, wenn man es so handhabt wie auf http://www.ubuntu-forum.de/ ? Denn die haben ein WIKI eingerichtet, wo jeder seine Erfahrungen mit seinem System verfassen kann. Dieses kann man dann unterteilen nach Hardware, ob diese dann auch mit Linux läuft und wie diese denn auch konfiguriert wird.

Der Unterschied zu dem Portal hier ist aber minimal. Die User schreiben hier doch schon über ihre Erfahrungen. Aber es bringt nichts, die selben Fragen tauchen immer wieder auf. Sicher könnte man versuchen es über eine bessere Gliederung und Moderation lesbarer zu machen und Redundanzen zu vermeiden. Das würde sowohl in einem Wiki als auch hier möglich sein. Das Problem ist, wer will das tun? Das ist ein Fulltime-Job. Ein potentieller Moderator könnte nicht mit Hilfe der User rechnen. Das kann man leicht an der Disziplinlosigkeit erkennen mit der der ursprüngliche ACHTUNG!-Thread von Hotzenplotz5 mit Supportanfragen zugespammt wurde. Zusätzlich wäre auch noch die Software für das Wiki regelmäßig zu pflegen, eventuelle Updates wegen Sicherheitslücken vorzunehmen.
Ich sehe jedenfalls niemandem im Team, der Lust verspürt diese Aufgabe zu übernehmen. In meinen Augen arbeitet aktuell jeder von uns an deutlich wichtigeren Themen.
Da du das Wiki für eine Lösung hältst, willst du es vielleicht übernehmen?

Gerald

Hallo,
Ich muss ein wenig ausholen um wirklich alles zu schreiben was mir dazu einfällt. Ich hoffe es wird nich zu viel zu lesen

Vor ziemlich genau 2 Wochen hat mir ein Freund von seinem Projekt VDR erzählt. (Er macht das schon Jahre lang) Ich hab mich 2 Tage eingelesen (hatte vorher absolut NICHTS mit Linux am hut), hab mir dann passende Hardware bestellt und ca. 3 Tage konfiguriert ( 3x Neu aufgesetzt. 1x Erste gehversuche mit Linux und yaVDR, 1x Kernelfehler durch einen Fehler meinerseits beim konfigurieren, 1x um alles Sauber und von Anfang an richtig zu machen.) Dieses System (Signatur) läuft nun(ich hatte wirklich viele- viele Sachen die nicht von Anfang an so liefen wie ich sie mir vorgestellt hatte) wirklich einwandfrei.

Ich würde fast sagen ich habe mittlerweile mehr Ahnung (auf 2 Wochen!) von Linux und der Kommandozeilenebene wie selbiger bei Windows (DOS). Dieses Verlangen nach Technik und das Verständnis von Hard und Software liegt mir seit Kindesalter. Nun habe ich es auch noch zu meinem Beruf gemacht: IT-Systemelektroniker im 2. Lehrjahr.

Zusammengefasst: Ich bin jung, habe zwar warscheinlich noch nicht viel aber immerhin etwas Ahnung von Linux / yaVDR, dafür wissbegierig und leicht zu belernen

Was ich damit sagen will, und ich hoffe es kommt auch so rüber:
Um eine Doku zu schreiben bzw dann aktuell zu halten bedarf es meiner Meinung nach nicht (nur) einem Geek mit viel Ahnung von der Materie (Linux/yaVDR) sondern auch jemandem, der noch Ahnung von Fehler hat und vor allem weiß wie man diese Dinge formuliert um auch die unerfahrensten User zu erreichen.

Nun b2t:
Ein Neuaufbau des Wikis wäre wirklich nicht schlecht. Ein Vorschlag hierzu wäre mMn auch folgendes:
verschiedene Dropdown Menüs bei dem ich Hardware auswählen kann, und mir dann die Fehler + Behebungen zu genau dieser Harware (wenn nicht sogar exakt der ausgewählten Kombination an Hardware) anzeigen lassen kann. Verständlich?

Gruß
Wastl

Zitat

Original von WastlJ
Nun b2t:
Ein Neuaufbau des Wikis wäre wirklich nicht schlecht. Ein Vorschlag hierzu wäre mMn auch folgendes:
verschiedene Dropdown Menüs bei dem ich Hardware auswählen kann, und mir dann die Fehler + Behebungen zu genau dieser Harware (wenn nicht sogar exakt der ausgewählten Kombination an Hardware) anzeigen lassen kann. Verständlich?

Ich zitiere mich mal selbst:

Zitat

Ich sehe jedenfalls niemandem im Team, der Lust verspürt diese Aufgabe zu übernehmen. In meinen Augen arbeitet aktuell jeder von uns an deutlich wichtigeren Themen. Da du das Wiki für eine Lösung hältst, willst du es vielleicht übernehmen?

Gerald

Weiß nicht ob mand as rauslesen konnte, aber ich würde mich durchaus bereit erklären da mitzuwirken. Wenn sich genügend Leute v.a. auch mit Wiki erfahrung dazu bereit erklären bin ich gern dabei!
Klar wird der Neu/Aufbau wohl am meisten Zeit verschlingen. Nicht zu vergessen die Planung. Schließlich muss das System ja auch zukunftssicher sein. Um nich bei einer neuen Version wieder neu anfangen zu müssen. usw...

Um deine Frage konkret zu beantworten:

JA, ich würde mich dazu bereit erklären, mit den obigen Voraussetzungen.

Die Verbindung zum Team wäre noch wichtig. Und natürlich wer sich noch dazu bereit erklären würde

Jemand interesse?

Wenn das Doku-Team festeht müsste erstmals ein Zusammentreffen stattfinden mit Ideen, Vorschlägen usw...

Zitat

Original von gda
Da du das Wiki für eine Lösung hältst, willst du es vielleicht übernehmen?

Eines zu verwalten? Würde ich wohl gerne machen.

Einen Einwurf von einem Noobie, wie funktioniert das ubuntuusers wiki? Ist das einfach so eine viel größere community, wo jeder etwas schreibt und es viele Mods gibt die Ahnung haben und das dann freischalten ggf. verbessern und ergänzen?

Oder ist das wiki einfach mit den Entwicklungen gewachsen?

Frage mich nur wie das bei anderen Projekten funktioniert. Wenn zu sehr OT einfach löschen...

Zitat

Original von Wicky
Und da hakt es. Wir haben nicht genügend fähige Leute die sich um qualitativ hochwertige Doku kümmern... Ich hoffe diese Diskussion motiviert den einen oder anderen.

Fähig wäre jemand, der genauso gut in der Lage wäre selber zu Coden, denn derjenige hätte als eigene Doku-Quelle eben nur die Sourcen zu Verfügung. Wir hätten nichts gewonnen, wenn wir dem Doku-Schreiber erst ne Doku schreiben müssten. Das Problem dabei ist, warum sollte Einer der in der Lage ist zu Coden, Doku schreiben wollen?

Zitat

Original von Wicky
Hmm, könnten wir jemanden engagieren, der gegen Bezahlung, z.B. halbtags, die Dokumentation betreibt? Finanzierung durch einen Verein... oder eine andere Rechtsform... Bekäme man das Geld zusammen?

Sehr eigenartige Überlegung. Hmm, ich muss mal darüber nachdenken.

Wirklich eigenartig, jemand bekommt Kohle dafür, dass er unsere unentgeltliche Arbeit dokumentiert. Das dürfte meine Frau nie sehen, geht zu viel Geld ins Hobby.

Gerald