CopyrightDer Autoren-Guide

Tipps zum Schreiben von HowTos

Das Schreiben von HowTos und Dokumentationen kann sehr viel Freude bereiten und eine erfüllende Beschäftigung sein. Man gibt sein Wissen weiter (gut für das Ego) und lernt gleichzeitig etwas dazu, weil möglicherweise das Sekundärwissen zu einem bestimmten Thema erweitert werden muss.

Einsteiger sind stets voller Begeisterung, tun sich aber zumeist schwer beim Einstieg. Sie wollen natürlich alles richtig machen, jedoch fehlt ihnen noch der große Überblick. Allen Besuchern, die sich damit angesprochen fühlen, möchten wir hier einige Tipps und Tricks mit auf den Weg geben. Einen roten Faden im Labyrinth, damit das erste(?) HowTo nicht in Frust und verlorener Zeit endet.

Nicht zuletzt wird auch das Team von ServerHowTo.de dadurch entlastet, weil zeitraubende Rückfragen und mehrmaliges Rücksenden der Dokus für Korrekturen auf ein Minimum beschränkt werden können.

Hinweis: Der Begriff „Doku“ wird ab hier stellvertretend für alle Arten von Anleitungen verwendet.

1) Fachkenntnisse

Wer eine Doku schreibt, sollte sich im Thema auskennen. Klingt banal und selbstverständlich, ist es aber nicht. Wenn Sie sich also mit dem Gedanken tragen, eine Doku zu erstellen, gehen Sie das Thema einmal theoretisch im Kopf durch. Machen Sie sich einige Notizen und überprüfen Sie Ihren Wissensstand. Wenn Sie Lücken entdecken oder sich bei einigen Details nicht ganz sicher sind, haben Sie endlich wieder einen Vorwand, Fachlektüre zu schmökern oder im Internet zu recherchieren.

2) Die Struktur

Für die Planung einer Doku und die Organisation des Inhaltes ist es immer hilfreich, sich an einer Struktur zu orientieren. Folgende Struktur passt hervorragend in das Konzept von ServerHowTo.de:

  1. Inhaltsangabe
    Um was geht es in der folgenden Doku? 2 – 5 Sätze reichen meistens aus.
  2. Ziel
    Was soll letztendlich mit dieser Doku erreicht oder umgesetzt werden?
  3. Vorraussetzungen
    Was wird für die Umsetzung der Doku benötigt (Software, Hardware, bestimmte Konfigurationen)?
  4. Beschreibung
    Die eigentliche Doku mit allen Arbeitsschritten.
  5. Anhang
    Quellenangaben, Links zu weiterführenden Informationen oder zusätzliches Material (Texte oder Bilder), dass auf einzelne Punkte in der Doku weiter eingeht, jedoch den Doku-Text überfrachtet hätte.

3) Schreibstil

Eine Doku ist keine Prosa und Handbücher werden üblicherweise nicht für den Literatur-Nobelpreis vorgeschlagen. Niemand verlangt von Ihnen Sätze für die Ewigkeit. Eine Doku soll pure Informationen vermitteln. Also keine geschraubten „schöngeistigen“ Formulierungen, keine kunstvoll verschachtelten Sätze. Sachlich, schnörkelos, geradeaus. Die Leser werden es Ihnen danken.

4) Deutsche Sprache, schwere Sprache

Ja, böses Thema. Auch Eingeborene kämpfen zuweilen mit den Tücken ihrer Muttersprache. Neben dem Duden, der in keinem gut sortierten Haushalt fehlen sollte, bieten moderne Textverarbeitungsprogramme auch eine Rechtschreibprüfung. In Microsoft Word zu erreichen mit der Taste „F7“. Nutzen Sie das kleine Helferlein.

5) Lesen Sie gute Dokus

Das sind Dokus, die leicht und flüssig zu lesen sind. Wo der Stoff zwar komplex aber jederzeit verständlich ist und am Ende „hängenbleibt“. Wo der Autor Sie mitnimmt und immer auf Augenhöhe hält. Schon bald bekommen Sie ein Gespür dafür, was eine gute Doku ausmacht. Machen Sie es den Könnern nach.

6) Vorsicht: Lücke!

Wer zu einem bestimmten Thema umfassendes Wissen besitzt und dazu eine Doku schreibt, gerät schnell in Gefahr, etwas zu „unterschlagen“. Das geschieht nicht in böser Absicht, sondern weil er dieses Wissen – auch beim Leser - als selbstverständlich voraussetzt. Schon hundert mal angewendet, nicht mehr erwähnenswert. Leider können fehlende Details eine ansonsten hervorragende Doku für den Leser unbrauchbar machen. Achten Sie in Ihrer Doku daher auf solche Beschreibungslücken.
Wenn Sie schreiben: „Starten Sie das Programm XY und rufen Sie das Server-Log auf...“, dann beschreiben Sie bitte auch, wie das Programm gestartet wird und wo das Server-Log zu finden ist.

7) Fertig

Wenn Ihre Doku fertig ist, schieben Sie das Dokument in den hintersten Winkel Ihrer Festplatte und vergessen das Teil ganz einfach. Mindestens für einen Tag, besser 2 bis 4 Tage. Nicht reinschauen, nichts ergänzen, Tabuzone für die Maus.
Nach dieser „Reifezeit“ lesen Sie Ihre Doku noch einmal aufmerksam durch. Versuchen Sie, dabei den sachlich-kühlen Blick eines Aussenstehenden zu bekommen. Als wäre es nicht Ihre Arbeit, sondern die eines Anderen. Sie werden bald über einige Details stolpern, die Ihnen nun nicht mehr gefallen. Sie werden sehr wahrscheinlich Sätze umstellen, hier und da andere Begriffe wählen oder Lücken füllen. Die ganz Abgebrühten bringen es sogar fertig, überflüssiges Geschwaffel einzudampfen oder endgültig rauszuwerfen. Wenn Sie das schaffen, sie sind auf dem richtigen Weg.

Wohin mit der frischgebackenen Doku? Als *.zip-Archiv mit Text und allen Grafiken an die bekannte Adresse:  doku(at)serverhowto.de


Das Team von ServerHowTo.de wünscht Ihnen gutes Gelingen mit Ihrer Doku.

 

CopyrightDer Autoren-Guide