Firebird Documentation Index → Firebird Docwriting-Anleitung → Vorbereitung aufs Schreiben: Erstellung eines Abrisses! |
Es ist immer eine gute Idee einen Abriss zu erstellen, bevor man anfängt zu schreiben. Dies hilft Ihnen sich zu „organisieren“. Außerdem verringert er das Risiko etwas wichtiges zu vergessen und es macht das Schreiben deutlich leichter.
Folgen Sie diesen Schritten, um einen Abriss zu erstellen:
Definieren Sie genau, was Ihre Leser von Ihrem Werk lernen sollen.
Teilen Sie das Thema in logische Einheiten auf - Kapitel und/oder Bereich bzw. Unterbereiche.
Stellen Sie sicher, dass die Reihenfolge der Einheiten Sinn macht. Insbesondere für Howtos, Tutorials oder Anwenderhandbücher. Das heißt: Arrangieren Sie die Einheiten so, dass der Benutzer das was er als erstes tun oder lernen muss auch zuerst liest.
Legen Sie den Abriss der Mailinglist firebird-docs auf sourceforge.net vor und fordern Sie Kommentare hierzu.
Sobald Sie zufrieden mit Ihrem Abriss sind, schauen Sie sich diesen nochmals genau an und entscheiden Sie, ob alle notwendigen (Roh-)Informationen vorhanden sind, die Sie zum Schreiben benötigen. Idealerweise sollten Sie diese vorliegen haben, bevor Sie beginnen, da manchmal ein fehlendes Stück Info ausreicht, Ihre gesamte Dokumentenstruktur zu überarbeiten. Also ist es besser diese Information schon vorher zu haben.
Firebird Documentation Index → Firebird Docwriting-Anleitung → Vorbereitung aufs Schreiben: Erstellung eines Abrisses! |