Hallo,
um die Dokumentationsqualität unserer Software zu erhöhen möchte ich
mir bei empfehlenswerten Autoren etwas abschauen. Welche Verlage bzw.
Autoren zählen nach Eurer Erfahrung zu den Besten?
Gruß, Robin
Also ich kann Dir zwar keine Autoren nennen, aber warum gehst Du die Sache nicht anders an? Ich bin ansich jemand, der Handbücher soweit meidet und lieber erstmal selber tüftelt. Wenn ich dann nicht weiter weiß, schlage ich im Handbuch nach. Rührt auch sicherlich daher, weil alle Handbücher irgendwie gleich trocken aufgebaut sind.
Vor langer Zeit hatte ich mal ein Programm gekauft, über dessen Handbuchaufmachung ich recht überrascht war und das war das erste - und bisher einzige - Handbuch, daß ich erst komplett durchlas, bevor ich überhaupt die Software installierte.
Im Vorwort stand geschrieben, daß sich der Hersteller bei der Erstellung des Handbuchs eben genau um den Umstand des Nicht-Lesens der Handbücher Gedanken machte und sich überlegte, wie er seine Kunden dazu bringt, es doch zu lesen.
Was liest denn sonst so ziemlich jeder von uns tagtäglich? Die Zeitung! Also warum das Handbuch nicht wie eine Zeitung aufmachen? Gesagt, getan…Ziel erreicht! Fand ich klasse!
Nur mal so als kleiner Tip. 
Hallo!
Ich weiß zwar nicht ganz genau was du dokumentieren willst und wie.
Folgendes Dokument finde ich eine recht gute Anleitung für FreeBSD. Man kommt eigentlich recht weit damit und es ist lesbar geschrieben:
http://www.freebsd.org/doc/de_DE.ISO8859-1/books/han…
Zur Dokumentation der Programmiersprache VB.NET finde ich die MSDN sehr gut. Da kann ich mir die einzelnen Klassen ganz genau anschauen, wie ich sie aufrufe usw.
http://msdn2.microsoft.com/de-de/library/ms229335.aspx
Auch die Dokumentation von Apache ist gut zum Nachschlagen einzelner Direktiven.
http://httpd.apache.org/docs/2.2/
mfg
christoph
Hallo,
hört sich interessant an. Aber ich müsste mir das einmal selber ansehen. Kannst Du mir vielleicht das Produkt und den Hersteller nennen, wenn Du den Autoren nicht kennst? Wäre super.
Gruß und danke,
Robin
hört sich interessant an. Aber ich müsste mir das einmal
selber ansehen. Kannst Du mir vielleicht das Produkt und den
Hersteller nennen, wenn Du den Autoren nicht kennst? Wäre
super.
Boah…das war irgendein Uralt-Programm für meinen alten Mac. Keine Ahnung, was das noch war. Liegt wahrscheinlich auch irgendwo im Haus meiner Eltern einige 100km weg.
Nimm Dir einfach 'ne „Bild“ und bau das Handbuch in dem Stil auf. Dann kannste wohl nicht viel verkehrt machen. Ich weiß, ist mal was vollkommen neues, wo man sich erst reinfinden muß, aber wenn man erstmal einen Ansatz hat, sollte es sicher gut weitergehen, denn da ist dann ja auch Kreativität gefragt. 