Die Schreibhilfe technischer Dokumente erfolgt in vier aufeinanderfolgenden Schritten.

Schritt 1: Gespräch mit dem Hauptautor (oder Korrespondenzautor), Erstellen einer Zusammenfassung und Inhalt auf oberster Ebene (Inhaltsverzeichnis)

Im ersten Schritt führe ich mit dem Hauptautor oder dem Korrespondenzautor, der die Autoren nach außen vertritt, ein Gespräch über das gewünschte Dokument. Der Haupt- oder Korrespondenzautor stellt mir das Thema des Dokuments und den beabsichtigten Inhalt vor. Dann beantworten wir gemeinsam mehrere Fragen:

1. Wer sind die Leser dieses Dokuments? Welche Lesergruppe sollen angesprochen werden?
2. Welche Hauptbotschaft soll das Dokument vermitteln?
3. Was sollen die Leser lernen und an was sollen sie sich erinnern?
4. Welche andere, unbeabsichtigten Lesergruppen gibt es, zum Beispiel Konkurrenten?
5. Welche vielleicht vertrauliche Information soll unbeabsichtigten Lesern vorenthalten werden?
6. Welche sind die Koautoren und was tragen sie zum Schreiben bei?
7. Welche Termine und Verzögerungen müssen berücksichtigt werden?

Nach diesem Gespräch bereite ich einen Entwurf in Form einer Kurzfassung (Abstract) und einer erweiterten Zusammenfassung von etwa 250 bis 400 Worten vor und liefere einen Vorschlag für den Inhalt und Aufbau des Dokuments in Form eines Inhaltsverzeichnisses.

Der Haupt- oder Korrespondenzautor erhält beide Entwurfe (Kurzfassung und Inhaltsverzeichnis) innerhalb einer Woche nach dem Gespräch zur Einsicht und für Korrekturen.

Schritt 2: Gespräch mit Korrespondenzautor und den beitragenden Mitautoren; Inhalt auf zweiter Ebene

Der zweite Schritt schließt den führenden Autor und die beitragenden Mitautoren ein. Sie liefern ihre Änderungen zum vorgeschlagenen Inhalt auf oberster Ebene (Inhaltsverzeichnis). Ich treffe sie zu einem vertiefenden Gespräch über den Inhalt ihrer jeweiligen Beiträge/Kapitel. Bei dieser Gelegenheit geben die beitragenden Mitautoren an, welche Abbildungen oder Formeln/Gleichungen sie in das Dokument einbringen wollen. Sie werden diese Abbildungen oder Formeln später während der Erstellung des Dokuments nach ihren Wünschen liefern. Die Mitautoren bestimmen auch die Reihenfolge, in der ich ihre Beiträge schreiben soll.

Nach diesem Gespräch bereite ich einen Vorschlag für den Inhalt auf zweiter Ebene vor, der den Abschnitten in jedem Kapitel entspricht. Diese Abschnitte geben die Ideen des Dokuments in logischer Reihenfolge wieder. Der Inhalt auf zweiter Ebene zeigt auch die Stellen an, wo Abbildungen, Tabellen oder Formeln eingefügt werden. Der Inhalt auf zweiter Ebene hat die Form einer nummerierten Liste in zwei Spalten; sie erstreckt sich normalerweise über ein bis zwei Seiten.

Ich liefere dem Hauptautor diesen Inhalt auf zweiter Ebene innerhalb einer Woche nach unserem Gespräch. Der Hauptautor regelt die Bearbeitung der Inhalte mit seinen Mitautoren. Gemeinsam lesen und korrigieren sie den Inhalt auf zweiter Ebene, um besser ihren Gedankengang und all ihre Dokumentationspläne darzustellen. Die Mitautoren können entscheiden, ob sie den ersten Entwurf ihrer Beiträge selbst schreiben wollen oder ob sie es vorziehen, dass ich den ersten Entwurf schreibe.

Schritt 3: Verfassen der einzelnen Kapitel

Der dritte Schritt ist das eigentliche Schreiben, Kapitel nach Kapitel. Ich schreibe die Kapitel in der Reihenfolge, wie die Autoren mir diese gegeben haben. Allerdings erstelle ich das Kapitel „Einführung“ erst, nachdem alle anderen Kapitel als Erstentwurf geschrieben worden sind. Ich werde die Punkte des Inhaltes auf zweiter Ebene (nummerierte Liste) als Untertitel vor jedem Abschnitt einfügen, um auf diese Weise die Korrekturarbeit zu vereinfachen. Ich füge die Abbildungen, Tabellen und Formeln in den Text ein, soweit die Autoren sie eingereicht haben. Ich werde aber keine eigenen Abbildungen und Tabellen erstellen.

Jedes Kapitel wird ein bis zwei Seiten lang sein. Ich liefere den ersten Entwurf jedes Kapitels in hinreichend ausgereifter Form dem führenden Autor und dem verantwortlichen Mitautor bei etwa einem Kapitel pro Woche. Alle Mitautoren sind dann selbst verantwortlich, die Kapitel zu lesen, zu korrigieren und sie ihrem eigenen Schreibstil anzupassen. Sie sollten auch selbst Abbildungen, Tabellen und Formeln in den Text einfügen, wenn sie diese nicht vorher eingereicht haben.

Schritt 4: Zusammenstellung des endgültigen Dokuments

Der vierte und letzte Schritt ist die Zusammenstellung des endgültigen Dokuments. Dieser Schritt stellt sicher, dass das gesamte Dokument konsistent in Inhalt und Stil für alle Mitautoren ist. Dieser Schritt kann auch die Umwandlung in ein Format enthalten, das vom Verleger verlangt wird.