der CV-Dokumentations-Verbesserungsvorschläge-Thread

[MGK]

harter Name, aber nach meiner Erfahrung ist (brauchbare) Dokumentation immer das grosse Problem bei OpenSource... und das ist bei der CV nicht anders...

ich dachte hier sammeln wir mal alle Sachen die in der Dokumentation fehlen oder "nicht toll" sind...

(ich habe derzeit echt wenig Zeit, helfe aber später gerne mit bei der Doku)

[MGK]

und ich habe gleich die ersten Punkte über die ich als "Anwender" stolpere...

- Diagramm ist nicht dokumentiert
- Startseite CV Projekt sieht aus als ob da seit Jahren nix passiert (FF 8.0 ????)

Gruss,
Michael

P.S: nochmal: das ist KEINE Kritik, die CV-Entwickler machen m.E. grossartige Arbeit, aber was würdet Ihr als Neuling/Anwender von einer Projekt-Seite halten die von FireFox 8.0 handelt?)

[swiss]

Naja Fakt ist, dass ich momentan der einzige bin der ab und zu mal was dokumentiert. Doch habe ich auch noch ein Privatleben und neben 100% Beruf und 100% Haushalt auch noch Freundschaften zu pflegen und nebenher noch viele Private Projekte. Da sollte auch verständlich sein, dass die Doku nicht immer in allen Bereichen aktuell sein kann...

Mir ist bewusst dass die Doku noch eine grosse Baustelle ist aber wie gesagt. Mekkern ohne bis jetzt Eigenleistung in der Hinsicht erbracht zu haben ist auch nicht ganz Fair. Ich habe momentan auch wehnig Zeit (Eigentlich fast immer)! Aber ich versuche neben bei auch noch die CV Doku zu pflegen...

Also ein etwas gemässigter Titel würde ich schon für angebracht halten. Zumal 90% der Doku von mir alleine Stammt und ich als momentaner Einzelkämpfer auch nicht nur für die Doku lebe.

Eine Sammlung von offenen Baustellen ist sicher nicht schlecht. Auch wenn die ganze Doku eine grosse Baustelle ist...

Dazu gehören:

- Einsteigertutorial fertigstellen
- Fortgeschrittenen Tutorial erstellen
- Navigation und Seitengestallung für Mappings, Stylings, Plugins, Format usw...
- Fertigstellen einiger Widgetbeschreibungen und aktualisieren der Screenshots
- Mehr Beispielconfigs einpflegen
- Mehr Beispielconfigs auf dem DemoWG als Lividemo anbieten
- Browserkompatiblität prüfen und Tabelle aktualisieren (wobei dies schwierig ist, da ein Browser unter z.B. unter Win funktionieren kann und unter Mac nicht)
- Beschreibungen und Anleitungen für Plugins wie rsslog erstellen
- Rechtschreibung prüfen

usw...

Und der Fluch daran ist... Sobald die Beschreibungen passen, müssten sie beim nächsten Update (0.8.1 soll bald kommen) wieder erneut überprüft werden da durch das Update zum Teil Fehler behoben werden und Kompatiblitäten verbessert. Die Änderungen können aber auch dazu führen, dass plötzlich Dinge die zuvor funktioniert haben nicht mehr gehen usw...

Das ist ein ewig leidiges Thema. Die Doku wird also NIE aktuell sein. Die ist in jedem Fall immer hinterher

[MGK]

GENAU DAS hatte ich befürchtet... (ich hätte das nicht posten sollen)

Ich dachte es wäre hilfreich wenn man die "schlimmsten" Stellen der Doku aus Sicht eines "Anwenders" und später Fehler und Löcher in der Dokumentation mal in einem Thread festhält.

Wenn Ihr das nicht so seht: löscht den Thread bitte.


Michael (der selber technische Doku schreibt und genau weiss wie das ist)

P.S. ich weiss das ich das Projekt nur nutze und bisher wenig beigetragen habe... das wird sich hoffentlich ändern wenn das Haus endlich steht :/

[swiss]

Naja der Titel hat mich schon etwas hart getroffen. Zumal ich die Doku nahezu alleine und IN MEINER FREIZEIT also komplet OHNE GEGENLEISTUNG pflege...

Dass du Technische Doku pflegst finde ich super. Das gibt dir wehnigstens ein wehnig Verständniss für den Aufwand der dahinter steckt. Aber machst du dass beruflich/gegen Bezahlung oder auch mit VIEL Freizeit und Kostenlos?? Denn genau daran liegt es momentan. Da die Pflege der Doku viel Freizeit benötigt die ich eigentlich momentan überhaubt nicht habe, ist sie auch nicht so aktuell wie sie sein sollte.

[MGK]

der Name des Threads war schon Absicht - allerdings eher provokativ als "dem armen Schwein der die Doku in seiner Freizeit macht ins Seelenleben treten" - wir sollten den Thread wirklich löschen lassen.
man verliert nur leicht den Überblick was der "Anwender" sieht, deshalb dachte ich das hier wäre hilfreich.

sorry wenn das irgendwen persönlich getroffen hat - das war das letzte was ich beabsichtigt habe!!!

Michael

P.S. ich mache das sowohl beruflich als auch (wenn auch sehr wenig in letzter Zeit) in der Freizeit für OSS - kenne also beiden Seiten -

[Chris M.]

wir sollten den Thread wirklich löschen lassen.

Löschen wäre schon machbar - mache ich aber nur ungern. Wir könnten ja ein Umbenennen versuchen. Vorschläge?

[swiss]

Ja umbenennen wäre mir recht

Denn es ist schon ein Thema, dass behandelt werden sollte. Aber bitte nicht als Mekker Thema. Lieber sachlich / kostruktiv. Dann bekommen wir sicher einen guten Überblick über die offenen Baustellen und können sie der Dringlichkeit nach bearbeiten

Was auch noch ausstehend ist...

- Eine gescheite Schritt für Schritt Installationsanleitung mit screenshot. Auch wenn mir da ein Bashscript mehr als recht käme (in einem zweiten Schritt könnte das Bashscript z.B. über einen Link aus dem Editor aufgerufen werden)

[Micro1972]

Hallo,

kann man die "Baustellen" an der Doku nicht direkt dort aufnehmen, dann ist alles an einer Stelle nachlesbar?

LG Mirko

PS: Wie kann ich eigentlich eine Beispielvisu auf mein Wiregate kopieren, hab leider von Linux keine Ahnung?

[swiss]

Da hast du wieder eine offene Baustelle entdeckt:

- Anleitung um Configs auf das Wiregate zu kopieren oder von dort für Backup herunter zu laden.

Das behandeln wir aber besser in einem separaten Thema bis der Handbucheintrag fertig ist

PS: Naja das Problem ist, dass nicht jeder Schreibrechte auf dem Handbuch hat. Da müsste man sich also etwas einfallen Lassen. Aber ich gebe dir recht. Mit der Zeit wird dieser Beitrag bestimmt unübersichtlich. Eine art "Bug Tracker" für die Doku wäre gut.

[Micro1972]

Für das Wiregate wird an anderer Stelle gerade über die Art und Weise der Erstellung sowie Pflege einer Doku diskutiert, vielleicht kann man ja das selbe System nutzen.

Verrätst Du mir das mit dem anderen Design oder muss ich googlen? Vielleicht kann ich vereinzelt bei der Doku helfen, auch wenn wir im Dezember gerade Nachwuchs bekommen haben.

[swiss]

Was meinst du mit...

Verrätst Du mir das mit dem anderen Design oder muss ich googlen?

?? Möchtest du wissen wie man zwischen den Designs wechselt oder was möchtest du gerne wissen?

[Micro1972]

Ich möchte wissen, wie ich ein weiteres Design auf mein Wiregate bekomme.
Es lassen sich doch mehrere Designs nebeneinander ablegen.

Die 2. Frage ist, wie ich die Dateien ohne CV-Editor bearbeiten kann?

Danke schonmal für die Mühe.

PS: Das mit der Doku lass Dir mal in Ruhe durch den Kopf gehen, gegen Hilfe hast Du ja sicher nichts einzuwenden.

[swiss]

Hallo

Ich werde dir gerne bei beiden Themen helfen und alle Fragen beantworten. Aber mach dazu bitte ein eigenes Thema auf da dies einerseits off topic wäre und andererseits den Rahmen dieses Themas sprengen würde

Zum Thema Hilfe bei der Doku... Die nehme ich immer gerne dankbar an Jeder der möchte darf sich gerne daran beteiligen

Mir würden auch Hilfestellungen wie z.B. Browserkompatiplitätstests helfen damit man mal aktuelle Daten für die Kompatiplitätstabelle hat usw...

[Micro1972]

Ok, hab gerade ein neues Thema mit meinen Fragen angelegt. Ich wollte mich hier nicht reindrängeln.

Wie kann ich mich denn an der Doku beteiligen?