Meine Thesen zur yaVDR Dokumentation
1. Inhaltliche und qualitative Aspekte der Dokumentation haben oberste Priorität
2. Technische und Aspekte der Mehrsprachigkeit haben untergeordnete Priorität
1.1 Artikel sollten formale Regeln einhalten:
-> Einleitender Text
-> Angabe der Gültigkeit für bestimmte Versionen
-> Inhaltsangabe
-> geeignete Struktur des Artikels
-> unten Links
Hier kann man sich sehr gut an http://wiki.ubuntuusers.de orientieren
1.2 Artikel sollten verständlich und leserorientiert sein
siehe hierzu auch:
http://de.wikipedia.org/wiki/Wikipedia…te_Artikel#Stil
-> kurze Sätze
-> Verb nach vorne
-> Zielgruppen orientiert !!!
1.3. Die Doku sollte eine sinnvolle Struktur besitzen
1.4 Eine yaVDR Daku <> VDR Doku !!
Eine yaVDR Doku sollte yaVDR dokumentieren und nicht nochmals den VDR.
-> VDR spezifisches, wie Plugin xyz, wird aufs VDR-Wiki verlinkt
-> yaVDR spezifisches, z.B. Installation und Templates, wird sorgfältig dargestellt
2.1 Media-Wiki, Semantik-Wiki...
Welche Software verwendet wird ist (fast) egal.
Was nutzt schlechter Inhalt in einem technisch gutem Wiki...
2.2 Mehrsprachigkeit ist toll, aber nicht wichtiger als Qualität
Was nutzt es, wenn ein Artikel in zwei Sprachen existiert, aber er in beiden Sprachen "Müll" darstellt?
Einen guten Artikel kann man hingegen gut übersetzen...
Mein Fazit:
(A) Wir benötigen eine Guideline / Richtlinien für die Dokumentation
-> darum will ich mich kümmern
(B) Wir benötigen eine inhaltliche Struktur, in die sich die Dokumentation einfügt
-> darum will ich mich kümmern
(C) Auch die technischen Aspekte müssen geklärt werden
-> darum kümmere ich mich nicht
Gruß
Wicky
P.S. Ist eigentlich klar was ich unter einer Guideline verstehe??