+ Antworten
Ergebnis 1 bis 3 von 3

Thema: Guter (verständlicher) Stil für Software-Anleitungen (Links, Hinweise gesucht)

  1. #1
    TP-Insider Jokai olvaso hilft, wo's geht Jokai olvaso hilft, wo's geht Jokai olvaso hilft, wo's geht Avatar von Jokai olvaso
    Registriert seit
    Nov 2004
    Ort
    Ulm
    Beiträge
    679

    Guter (verständlicher) Stil für Software-Anleitungen (Links, Hinweise gesucht)

    Ich muß eine allgemein verständliche Anleitung für eine gängige Software verfassen und zermartere mir gerade das Hirn, welche Herangehensweise wohl geeignet wäre.

    Seitdem es die Computer B*ld gibt, gibt es ja einen neuen Quasi-Standard für so Zeugs. Jede Kleinigkeit mit 5 Screenshots zu erläutern widerstrebt mir aber etwas. Daher meine Frage: hat jemand Links zu ähnlichen Anleitungen? Natürlich kenne ich Photoshop Tutorials und so Zeug, aber das ist für meine Zwecke schon wieder viel zu speziell.
    "Quis custodiet ipsos custodos?" Juvenal

    Die archaische Kultur von Minos hat dem Minotaurus alljährlich ihre Kinder geopfert, um Sicherheit zu gewinnen. Eine demokratische Kultur, die ihre Prinzipien dem Terrorismus in den Rachen wirft, handelt nicht anders. H. Prantl in NZZ Folio 09/07

    Webseiten & Datenschutz - eine kurze Zusammenfassung

  2. #2
    TP-Supporter SchneewittchenX hilft, wo's geht SchneewittchenX hilft, wo's geht SchneewittchenX hilft, wo's geht
    Registriert seit
    May 2007
    Ort
    Berlin
    Beiträge
    372
    Hi,
    ich schreibe auch ein Buch über ein Programm und kann Dir vielleicht mit ein paar Gedanken helfen:
    Vor Schreibbeginn sollte man sich selbst ein paar Fragen beantworten:
    1. Für wen schreibe ich? Totale Anfänger, vielleicht sogar Computerneuling, oder für Auf- und Umsteiger ähnlicher Programme bzw. älterer Versionen des Programms
    2. Wo soll das Buch gelesen werden? Auch in Bahn und Bus oder nur am Computer wie ein Handbuch?
    3. Was möchte ich beschreiben? Die vorhandene Programmoberfläche oder wie löse ich mit dem Programm ein bestimmtes Problem.
    Von diesen Entscheidungen hängt maßgeblich ab, wieviele und was für Bildschirmkopien Du benötigst.

    Um- und Aufsteiger brauchen nur im Einführungskapitel Bildschirmkopien der gesamten Oberfläche eventuell mit Gegenüberstellung alter Versionen oder vergleichbarer Programme. (Gerade bei der Fotobearbeitung werden Bücher oft für mehrere Programme geschrieben - hier ist eindeutig der Arbeitsweg das Entscheidende und nicht die Position und Benennung des Menüpunktes.)

    Für den Autor ist es einfacher, die Drucktaste zu drücken und die gesamte unbearbeitete Bildschirmkopie einzufügen, damit überlässt er es aber dem Leser, die wichtigen Stellen und Unterschiede zu vorhergehenden Bildschirmkopien zu finden
    Bildschirmkopien sollten schon nur das beinhalten, worauf man hinweisen will. Ich mache es so, dass ich bei Registerkarten im Text alles beschreibe, was warum wie einzustellen ist, die Bildschirmkopie (nur der Registerkarte) dient dann als Gedächtnisstütze und zum Übertragen der Werte. Der Nachteil ist, dass man oft die Kopien skalieren muss und deshalb gerade die wichtigen Werte schwer zu erkennen sind. Wenn nur wenige Werte einzutragen sind, helfen dann Ausschnitte, Pfeile und Beschriftungen. Das bedeutet, dass man für die Bildschirmkopien genauso viel Arbeit wie für den Text aufwenden muss.

    Bei dem von Dir genannten Beispiel ist es eher so, dass der Autor keine Arbeit haben will und nicht einmal das Dargestellte ordentlich beschreibt. Solche Bilderbücher landen nach einmaliger Benutzung im Schrank. Als Nachschlagewerk für die tägliche Arbeit taugen sie nichts, denn was im Buch abgebildet ist, sieht man ja auch auf dem Monitor. Wenn man das Programm einmal bedienen kann, hilft einem das nicht weiter. Dann braucht man Tipps mit welchem Programmpunkt man seine eigentliche Aufgabe lösen kann.

    Auffällig ist, dass englischsprachige Bücher viel weniger Bildschirmkopien enthalten und trotzdem leichtverständlich sind (oft auch, wenn Englisch nicht die Mutersprache ist.) Das liegt oft an den einfacher strukturierten Sätzen und was für uns Fremdworte sind, ist dort Umgangssprache.

    Ich habe mir vor Beginn des Schreibens auf http://www.storials.com/sites/fachbuch-sachbuch.php "Ein packendes Fach- und Sachbuch schreiben" gekauft, ob man das wirklich braucht, muss jeder selbst entscheiden, war aber schon ganz nützlich.

    Hier im Forum gab es auch schon mal einen Thread "Hat schonmal jemand ein Buch veröffentlicht?"
    Schau Dir mal besonders die Beiträge 12, 17 und 18 an. Dort findest Du Links und Partner.

    Ein Autorenforum findest Du unter https://www.xing.com/app/network?op=...e=autorenforum

    Links zu Beispielen kannst Du selbst suchen in dem Du Tutorial oder Anleitung und ein einschränkendes Thema in Google eingibst. Interessant können auch Leserrezensionen auf Amazon, Idealo und ähnlichen Seiten sein, insbesondere, wenn Du das Buch selbst kennst.

    PS: Du kannst auch mal in die Hilfe zu Wikibooks für Autoren schauen, wobei das mehr allgemein gehalten ist: http://de.wikibooks.org/wiki/Wikibooks:Hilfe

    SchneewittchenX
    Geändert von SchneewittchenX (26.10.2007 um 12:18 Uhr) Grund: Link hinzugefügt

  3. #3
    TP-Special Mod webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User webmichl lebt für das TP und seine User Avatar von webmichl
    Registriert seit
    Jun 2001
    Ort
    8°21' O 49°1' N
    Beiträge
    8.635
    Soll es eine Print- oder eine Onlineanleitung werden? Im zweiten Fall kannst Du es ja mit weiterführenden Links staffeln - die oberste Ebene ist kurz, knapp und präzise und die unterste hat dann das B-Zeitungs-Format mit 17 Screenshots und doppelt so vielen Fussnoten...

    Gruß, der Michl



    * * * if you want them to RTFM, make a better FM! * * *


+ Antworten

Aktive Benutzer

Aktive Benutzer

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)

     

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51