Gelöst Dokumenationserstellung: Vorgehensweise

Thomas Lisson

Administrator
Mitarbeiter
24. März 2006
15.574
299
Köln
Das wird eine große Hilfe beim Support.

Bei der HTML-Version setz ich mich hin und verlinke die Kapitel und Unterkapitel mit dem Inhaltsverzeichnis -> Damit man beim Suporten einfach nur den betreffenden Link angeben kann.

Auch von unserer Seite große Anerkennung an alle Dokuleute!

Und Marcel - danke für die undankbare Layoutarbeit!
 

gerhard5302

Sehr aktives Mitglied
Das Programm insgesamt entwickelt sich glücklicherweise in einer derart schnellen Dynamik weiter, dass man meiner Meinung nach letztlich an einer gleichzeitigen Onlinedoku (welches Format auch immer, CMS, Wiki, HTML...) nicht herumkommen wird. Jetzt auf eine reine PDF Doku mit Stand z.B. 23. März 2007 zu setzen, wäre mit Garantie der falsche Weg und für JTL ein Schuß ins eigene Knie. Insbesondere für Neueinsteiger!

Grundsätzlich: Wir "alten Hasen" leben mit dem Programm und wissen sowieso wo wie was zu finden ist und wie man das Forum bemüht.

Wenn man aber neue und vollkommen unbedarfte Anwender ansprechen will, braucht man einfach eine umfangreiche Doku auf aktuellem Stand.

Kein Boss einer größeren Firma spielt mit der neuesten Version der WaWi herum, studiert gleichzeitig eine 50 oder 100 Seiten Doku, merkt dabei daß einige beschriebene Funktionen ganz anders funktionieren und aussehen, wird dadurch verwirrt, und liest dann am Ende auch noch "Stand: 3 Monate zurück und aktuelle Informationen finden Sie immer im Forum auf http://www.....".
Der ist spätestens dann frustriert wieder weg und kommt nicht wieder, so schnell kannst Du gar nicht schauen. Zeit ist Geld. Mit veralteten Dokus rum ärgern wird sich freiwillig keiner antun.

Aus der Praxis: Optimal wäre eine sehr komprimierte DAU sichere Schnellstartanleitung als reine PDF Datei plus dort direkt in der 1. und letzten Zeile einen dicken fetten Verweis auf die umfangreiche und detaillierte Onlinedoku. Dort müßen dann aktuelle Neuheiten zmindest in erweiterter Form der bekannten Changelog sofort und unmittelbar einfließen.

Herzliche Grüße

Gerhard
 
Ähnliche Themen

Ähnliche Themen