Online-Dokumentation

Es hat mich ja schon lange genervt dass viele Programme/Sprachen/Framesets oder ähnliches nur Online-Dokumentationen anbieten aber in letzter Zeit wird das immer schlimmer (Das liegt sicher auch zum großen Teil daran, dass ich noch immer kein permanentes Internet in Dresden habe.)

Es ist einfach grauenvoll wenn man gerade mal wieder 3 Stunden in einer Bahn sitzt, das Notebook in der Tasche und eigentlich viel Zeit zum Arbeiten hätte. Leider hängt man nach 5min an einem kleinen Detail das man in Sekunden in der Doku finden würde, doch die Doku hat man natürlich mal wieder nicht mit.

Ich sehe es ja noch ein dass für viele Frameworks und Bibliotheken Bücher als Medium einfach zu langsam sind. Wenn sich alle 3-4 Monate ein neues Framework als Hype breitmacht oder komplett umgeschrieben wird, wie soll sich dann jemand hinsetzen und nebenbei auch noch ein Buch dazu schreiben? Von den armen Entwicklern die sich all die Bücher kaufen sollen dann mal ganz abgesehen. In dieser Beziehung musste ich neulich auch erst wieder feststellen wie verwöhnt ich bin. Plötzlich musste ich meine Bibliotheksgewohnheiten von einer vollen Etage voller IT-Bezogener Bücher (Bibliothek der WHZ) auf ein bis zwei Regale pro Zweigstelle (Stadtbibliotheken Dresden, die sind an sich schon ziemlich gut ausgestattet aber halt keine Fachbibliotheken) umstellen. Natürlich findet man dann eher seltener etwas zu neueren oder ausgefallenen Themenbereichen wie Python mit AppEngine.

Es sollte jedenfalls möglich sein die überall vorhandenen Online-Dokumentationen nicht nur Online lesen könnte sondern auch in irgendeiner statisch zusammengestellten Form runterladen könnte. Nicht in jeder Situation muss man permanent die aktuellste Version von vor einer halben Stunde im Wiki nachlesen, manchmal würde es auch die 6 Monate alte Version im PDF-Format oder noch besser als Tarball mit HTML-Seiten tun.

Manche Projekte verhalten sich bei diesen Dingen auch durchaus wie gewünscht, die Dokumentation zum Zend Framework gibt es z.B. jederzeit gut sichtbar zum Download, das gleiche gilt ebenfalls für CakePHP oder (als wohl bekanntestes Beispiel) für SelfHTML.

Andere Projekte scheinen das noch immer nicht verstanden zu haben. Ich würde mich z.B. für einen möglichen Job der demnächst anstehen könnte gerne schonmal ins Symfony Framework einlesen, die Online-Doku scheint auch recht umfangreich und hilfreich, leider gibt es keine wirklich praktikable Möglichkeit (vom Download jeder einzelnen Seite mal abgesehen) um das Ganze auf einen USB-Stick zu ziehen und mitzunehmen. Ach  halt... ich könnte natürlich das offizelle Buch ($29,10) dazu bestellen oder zu einem Workshop (1200€, in Frankreich) gehen, beides sehr deutlich auf der Seite angeboten. Trotz Doku unter GFDL ist man also ziemlich eingeschränkt, ein Schelm wer böses dabei denkt.

Importierte/Alte Kommentare:

#431: 13.Aug.2008 10:08 von sirsnookie

Das geht ganz einfach ;)

"wget --mirror --convert-links --backup-converted --html-extension -o log " Ich persönlich finde es auch immer wieder toll das es soetwas nicht fix zum download gibt. ich mein, heh das ist nun kein großer akt. bei django versteh ich das noch "halbwegs" da die, sobald änderungen an der svn version vorgenommen wurden, diese auch im handbuch dokumentiert werden.

#432: 14.Aug.2008 07:08 von Dr. Azrael Tod

naja, man könnte aber dann auch einfach ein script basteln das relativ aktuell das Handbuch zum Download anbietet...
Man muss ja nicht permanent die komplette Wiki-Datenbank umrechnen, ein Cronjob der das einmal am Tag macht würde dicke reichen.

#433: 07.Jan.2009 04:01 von ttwhy

Online Dokumentationen haben auch ihre Vorteile. Die Comments bei z.B. php.net sind unverzichtbar und bieten viele interessante Anwendungsmöglichkeiten, die man nicht einfach so unterschätzen sollte.
Bücher sind nur noch relevant für Themen, die extrem spezialisiert sind. Meistens veralten sie aber schon, nachdem sie gedruckt wurden (siehe Django von Python). Ein wenig nutzen hat web 2.0 ja schon :)

#434: 07.Jan.2009 04:01 von Dr. Azrael Tod

ähm.. dein Punkt im Bezug auf meinen Post war was?
Ich sehe durchaus ein dass das so ist, ich finde nur dass es (wenn sowieso schon eine Online-Doku vorhanden ist) kein Problem sein sollte die Doku auch komplett zum Download anzubieten. Ich fürchte nur halt dass dies mit Absicht erschwert wird, um mehr Bücher zu verkaufen oder so.

#435: 08.Jan.2009 11:01 von Friedenspanzer

CakePHP muss ich allerdings als ganz schlechtes Beispiel entlarven, die bieten nur Uralt-Versionen zum Download an in denen wirklich nur absolut grundlegende Dinge noch aktuell sind. Hat mich schon viele Nerven gekostet weil ich nicht auf die Versionsnummern geachtet habe.

#436: 08.Jan.2009 11:01 von Dr. Azrael Tod

Ging mir bei meinen wenigen Erfahrungen mit Cake bisher ähnlich.. auch wenn Symfony da neuerdings nicht wirklich besser ist, die meiste Doku bezieht sich nunmal noch auf Versionen lange vor 1.1, während bereits der Unterschied zwischen 1.1 und 1.2 mir einige Stunden anpassungsarbeit beschert hatte. -.-

Geschrieben von Dr. Azrael Tod
Older article
Cobol