Wiki: "Neue Features" ausgliedern...

Alles, was nicht direkt mit Python-Problemen zu tun hat. Dies ist auch der perfekte Platz für Jobangebote.
Antworten
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Freitag 24. Oktober 2008, 08:45

Es merkt anscheinend kaum jemand, wenn man im Wiki eine Diskussion anfängt :( Also nochmal hier, das Problem von: [wiki]Diskussion/Neue Features[/wiki]

Die Seite [wiki]Neue Features[/wiki] kennt sicherlich jeder. Sie ist nett, aber sehr sehr lang. Das hat mehrere Nachteile:
  • 1. Das Wiki kennt noch kein section-editing. Lange Seiten zu ändern ist somit recht unübersichtlich.
    2. Die Suche nach Titeln funktioniert nicht nach Seitenüberschriften. Wenn ich z.B. nach "subprocess" suche, wird erstmal nix gefunden, weil man explizit eine Suche in den Texten starten muß, die teilweise lange dauert. Die Treffer sind auch nicht so schön, siehe: wiki.python.de/Neue_Features?action=fullsearch&context=180&value=subprocess&fullsearch=Text (kann link nicht besser einfügen)
Es macht also IMHO mehr Sinn, die einzelnen sehr guten Abschnitte aus der Seite herraus zu lösen und auf seperate Seiten zu verteilen. Diese können dann zum einen in "Neue Features" und auch auf der [wiki]Tutorial[/wiki] Seite verlinkt werden.

Ich hatte das mal für "subprocess" gemacht, das hat Marek leider wieder rückgängig gemacht.

Gern können dir darüber erst Diskutieren und dann abstimmen.

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Freitag 24. Oktober 2008, 09:16

jens hat geschrieben:Es merkt anscheinend kaum jemand, wenn man im Wiki eine Diskussion anfängt :( Also nochmal hier, das Problem von: [wiki]Diskussion/Neue Features[/wiki]
Tatsache.
jens hat geschrieben:Die Seite [wiki]Neue Features[/wiki] kennt sicherlich jeder. Sie ist nett, aber sehr sehr lang.
Sie ist noch zu kurz, da ich in letzter Zeit wenig Lust/Zeit hatte da weiterzumachen. Und sonst schreibt da keiner etwas brauchbares.

Für die Gründe zitiere ich mich mal selbst:
Wiki-Diskussionsseite hat geschrieben:Übersicht. Das war auch der Grund warum ich es überhaupt erst angefangen habe. Mich hat es immer gestört, dass wenn es eine Neue Python Version gab, man erstmal alle möglichen Whatsnew-Dokumente durchlesen musste (sequenziell) um herauszufinden was das für ein Ding ist, was man da im Code sieht. So schaut man sich diese Seite an, kann mittels Browser Volltextsuche machen (Moins-Suche ist nicht halb so komfortabel) oder es in einem Stück ausdrucken. Das geht mit mehreren Seiten nicht. Zu jedem kleinen Abschnitt eine eigene Seite zu machen macht es nicht besser, denn wenn man so ein "Neues Feature" in der freien Wilbhabn trifft dann weiß man ja nicht dass es eine LC ist und nach [ zu suchen ist außer in der Volltextsuche des Browsers nirgendwo brauchbar implementiert. Wenn man es aufteilt kann man auch gleich den ganzen Text löschen und direkt die entsprechenden What's New-Abschnitte auf den Unterseiten verlinken, das hat dann den gleichen Effekt. Druckerfreundlich ist was anderes.
Es ist eine Übersicht neuer Features, keine detaillierte Beschreibung. Dafür ist die Dokumentation da und die ist auch in Stücke aufgeteilt (und zusätzlich als PDF druckerfreundlich, aber das bietet MoinMoin nicht).

Ich weiß dass Neue Features#subprocess oft verlinkt wurde, aber eigentlich war es nie als Einleitung zu Subprocess gedacht sondern als "subprocess für popen-User", also für Leute die nicht auf dem aktuellsten Stand sind, nicht für Leute die sowas das erste mal machen.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Freitag 24. Oktober 2008, 11:01

Also ich sehe keinen Mehrwert darin, das alle "neuen" Features untereinander aufgelistet sind. Zumindest reicht mir im Grunde eine Liste "Funktion XY ist in Version XY neu, mehr infos hier..."

Die Frage ist auch, was sind neue Features? Bzw. welche Version ist neu? Alle neuen Features ab 1.5? Ab 2.3? 2.4 usw.
Um so mehr man in die Vergangenheit geht um so mehr erstellt man IMHO eine komplette Referenz aller Features.

Außerdem finde ich es übertrieben, in der Liste jedes Feature ausführlich zu erklären. Eine Ausführliche Besprechung einzelner Features sollte IMHO auf einzelnen Seiten passieren. So wie es auf den Seiten [wiki]Tutorial[/wiki] angefangen wurde.

Natürlich kann man immer mit den Argument um die Ecke kommen: "Für sowas gibt es die Englische Referenz". Allerdings könnte man dann auch einfach sagen, warum betreiben wir überhaupt ein deutsches Wiki? Wir haben das englische Wiki, die Referenz und das Cookbook.

Wie sehen das die anderen?

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
BlackJack

Freitag 24. Oktober 2008, 11:13

Druckerfreundlich sollte IMHO nicht das Kriterium für die Aufteilung von Wiki-Einträgen sein. Ein Wiki ist kein Buch und das ist auch gut so. Bei einzelnen Wikiseiten kann man zielgerichteter darauf verweisen.

Falls ein ausgegliederter Abschnitt noch klein genug ist um als Ganzes in einem anderen Beitrag erwähnt zu werden, kann man ja eventuell das `Include`-Makro verwenden.

Solange ein Feature nur in der "Neue Features"-Seite steckt ist das ein Hindernis für Leute das ganze um weitere Erklärungen und ausführlichere Beispiele zu ergänzen weil die Seite eh schon ziemlich lang ist.
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Freitag 24. Oktober 2008, 11:58

jens hat geschrieben:Also ich sehe keinen Mehrwert darin, das alle "neuen" Features untereinander aufgelistet sind. Zumindest reicht mir im Grunde eine Liste "Funktion XY ist in Version XY neu, mehr infos hier..."
Du bist ja sowieso nicht das Zielpublikum des Eintrages, da du die Features ja kennst. Es solle eine Vorstellung der Features sein, keine detailierte Beschreibung.
jens hat geschrieben:Die Frage ist auch, was sind neue Features? Bzw. welche Version ist neu? Alle neuen Features ab 1.5? Ab 2.3? 2.4 usw.
Ab 2.0. Bzw. momentan seit 2.1/2.2, da ich zu Unicode nix geschrieben habe. Grundidee war, dass man auch etwas ältere Python-Bücher kaufen kann, durcharbeitet und danach sein Wissen auf den neuesten Stand bringen kann, mit einer Seite.
jens hat geschrieben:Um so mehr man in die Vergangenheit geht um so mehr erstellt man IMHO eine komplette Referenz aller Features.
Neue Features ist keine Referenz. Auch ist es sinnlos es ins Tutorial rüberzukopieren, da es nach dem Vorher-Nachher-Prinzip aufgebaut ist; in einem Tutorial ist es hingegen egal was davor war.
jens hat geschrieben:Außerdem finde ich es übertrieben, in der Liste jedes Feature ausführlich zu erklären. Eine Ausführliche Besprechung einzelner Features sollte IMHO auf einzelnen Seiten passieren. So wie es auf den Seiten [wiki]Tutorial[/wiki] angefangen wurde.
Also genauso verstreut wie in einem Buch. Neue Features ist eine Ergänzung zu einem Python-Buch; d.h. wenn man schon ein Buch durch hat muss man keine Zeit damit verschwenden, noch ein Tutorial zu machen.
jens hat geschrieben:Natürlich kann man immer mit den Argument um die Ecke kommen: "Für sowas gibt es die Englische Referenz".
Sowas gibt es nicht auf Englisch, das ist vergleichbar mit der Zusammenfassung von interessanten Änderungen in mehreren Python Versionen auf einmal. Also ein generelles What's New-Dokument was für mehrere Python-Versionen geht und weniger in die Tiefe. Die darf man selbst erkunden.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Sonntag 26. Oktober 2008, 20:10

Ich muss hier Leonidas beipflichten -- solange die Seite keine gigantischen Ausmaße annimmt, ist so eine Übersicht sehr praktisch.
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
Antworten