Stefan Weigel schrieb:
Mich persönlich stört an den meisten Handbüchern deren didaktischer Aufbau. Da werden sämtliche Details und Funktionen systematisch abgespult. Die Einführung beginnt mit der Aufzählung sämtlicher Bestandteile des Programmfensters, geht über fünf Varianten eine neue Datei anzulegen, eine zu öffnen oder zu speichern. Als nächstes werden die 368 Möglichkeiten, sich im Dokument zu bewegen aufgezählt und so weiter und so weiter. Das Ganze ohne jeden Praxisbezug. Nachdem ich die 21 Seiten des Kapitels 1 des Calc-Handbuches "Der Einstieg in Calc" durchgearbeitet habe, konnte ich an keinem noch so primitiven Beispiel sehen, was man mit Calc eingentlich macht. Im Kapitel 2 geht es im selben Stil weiter.

Ich finde gerade am Anfang sollte man einfache Praxisbeispiele in Form von Klick- und Tippanleitungen vorführen, die bewusst in Kauf nehmen, dass noch nicht jedes Detail erkannt, verstanden und erklärt werden kann. Anhand dieser konkreten Beispiele erlebt der Leser den Umgang mit dem Programm und erkennt durch Beobachtung die Grundzusammenhänge. Davon ausgehend kann man dann Detailfunktionen und spezielles behandeln.

Ich will bitte nicht als einer verstanden sein, der glaubt die Weisheit mit Löffeln gefressen zu haben. Ich halte mich selbst für keinen besonders guten Autor. Trotzdem, zur Erläuterung des von mir favorisierten Handbuchaufbaus verweise ich mal auf das von mir verfasste Kapitel 6 des Calc-Handbuchs "Datenpilot".

Ich beginne mit drei verschiedenen Beispielen aus der Praxis, die typische Aufgabenstellungen demonstrieren. Diese werden vorgeführt, in dem der Leser Klick für Klick angeleitet wird, mitzumachen. Wer nur die gängigen Features braucht, erfährt diese in einem Gesamtzusammenhang durchs bloße Mitmachen der Beispiele und braucht nicht weiter zu lesen. Weiter hinten werden alle Details genau behandelt.


Gruß

Stefan
(Der jetzt wieder bescheiden wird und zu anderer Arbeit zurück kehrt, leider.)

JA, genau so hätte ich es auch gesehen. Aber ich frage erst einmal nach und lese ein wenig mit.
Da  ich ja schon kurz HIER geschriehen habe.
Der Tipp von Wolfgang, erst einmal die vorhandenen Dokumente zu lesen ist aber auf jeden Fall sinnvoll. Daher kam ja auch meine Frage, was denn im einzelnen getan werden muss. Das wir einem auf den Internetseiten des Projektes nicht ganz deutlich. Geht es um die Übersetzung einzelner Kapitel der schon vorhandenen englischen Version, eine Befehlsreferenz für Nuter, die schon mal ein Office genutzt haben, oder ein Hilfe Buch, das zunächst Neulinge an die Openoffice.org Programmer heranführt, ohne auf vorhanden Kenntnisse aufzubauen.

Und wenn, wie ist es dann mit der Multiuser - Arbeit an einer Dokumentation?

Ach ja, das wird hier spannend werden.
Volker

(PS: was mir an der Vorlage für die Handbücher fehlt, ist eine für ein Stichwortverzeichnis, Glossar - ob es in der Vorlage fehlt weiß ich jetzt eigendlich nicht genau. Ich sehe jedenfalls keine Verzeichnisse in den einzelnen Dokumenten.)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Antwort per Email an