Inhaltsverzeichnis
Redaktionshandbuch und Konzept – wo liegt denn da der Unterschied?
Auf den ersten Blick sind sich beide tatsächlich ziemlich ähnlich. Denn sowohl Konzept als auch Redaktionshandbuch behandeln jeweils wichtige Aspekte, die in der täglichen Arbeit eines technischen Redakteurs auftauchen. Aber ganz so einfach ist es leider nicht, denn sonst wäre dieser Blogbeitrag auch ziemlich kurz.
Doch wo liegen jetzt eigentlich die Unterschiede?
Das Konzept
Eines möchten wir hier gleich vorweg nehmen: Unterschätzen Sie nie die Wichtigkeit eines Konzepts. Denn es bildet quasi das Grundgerüst für eine gute, und vor allem kunden- beziehungsweise anwenderfreundliche Dokumentation. Zweifellos ist die Erstellung eines Konzepts nicht die beliebteste Aufgabe. Aber sie ist unerlässlich für eine klare Struktur.
Doch wie erstelle ich jetzt ein gutes Konzept? Das beginnt quasi mit Basisarbeit.
Zunächst wird analysiert:
- Für welches Produkt soll das Konzept erstellt werden? Das kann von der großen Sondermaschine bis hin zur Software alles Mögliche sein
- Welche Gefahren können auftreten?
- Wie sieht meine Zielgruppe aus, und wie muss ich etwas formulieren, damit sie es auch versteht?
- Wie ist die Zielsetzung? Ein gutes Konzept sollte immer zielorientiert sein und sich nicht mit Nebensächlichkeiten aufhalten.
Dann geht es an die Umsetzung
- Wie groß ist der Umfang meiner Dokumentation?
- Auf welchem Medium soll meine Dokumentation erscheinen? Ist eine Druckausgabe geplant oder soll sie digital verfügbar sein oder vielleicht beides zusammen?
- Wie organisiere und plane ich, damit meine Dokumentation auch rechtzeitig fertig wird?
Hilfreich können auch Beispiele sein wie:
- Darstellungen
- Seiten
- Texte
Das Konzept ist also der Leitfaden, um die größtmögliche Kundenzufriedenheit zu erreichen. Mit einem Konzept wird im Prinzip präsentiert, was mit den einzelnen Dokumentationen erreicht werden und wie die Herangehensweise aussehen soll. Ein Konzept ist so gesehen eine interne „Bedienungsanleitung“ für die technischen Redakteure und alle anderen an der technischen Dokumentation beteiligten Personen. Es bildet quasi hierfür das Grundgerüst.
Kurz gesagt: Ein Konzept zeigt auf, was wie wann und für wen erstellt werden soll.
Das Redaktionshandbuch – auch Redaktionsleitfaden genannt
Der Weg zu einem fertigen Redaktionshandbuch beziehungsweise Redaktionsleitfaden kann lang, schwer und unter gewissen Umständen ziemlich steinig werden. Denn die Gestaltung liegt nicht nur allein beim technischen Redakteur sondern auch bei vielen anderen Personen.
Was ist das Redaktionshandbuch eigentlich?
Das Redaktionshandbuch ist ein Leitfaden, der genau vorgibt, wie eine fertige Dokumentation auszusehen hat. Dieser Leitfaden gewährleistet also, dass Konsistenz und Qualität der Dokumente stets gleichbleibend ist. Einfacher gesagt ist er eine interne Bedienungsanleitung für die technischen Redakteure und anderer an der Erstellung von technischer Dokumentation beteiligten Personen.
Dort finden sich Vorgaben wie z. B.:
- Das Layout und wie es auszusehen hat. Das betrifft auch den Satzspiegel und die Seitenränder
- Die Dokumentation und wie sie gegliedert und strukturiert sein soll. Das gilt auch für Verzeichnisse und Querverweise
- Das Corporate Design und wie es auszusehen hat
Doch nicht nur diese Dinge sind im Redaktionshandbuch geregelt. Außerdem noch folgende Punkte:
- Toolbeschreibungen wie Grafikbearbeitung, Textverarbeitung und Redaktionssystem
- Verfahren und die einzelnen Prozessschritte
- Protokolle, Verteiler, Checklisten
Außerdem wird auch die Terminologie festgelegt. Das heißt: Welche Begriffe darf ich verwenden, und welche nicht. Eine korrekte Terminologie ist übrigens auch äußerst hilfreich, wenn eine Dokumentation in eine Fremdsprache übersetzt werden soll.
Warum braucht man eigentlich ein Redaktionshandbuch in der technischen Dokumentation?
Ein Redaktionshandbuch wird nicht erstellt, um den technischen Redakteur zu ärgern oder um ihm zusätzliche Arbeit aufzubrummen. Vielmehr ist der Leitfaden ein sehr wertvolles Hilfsmittel für:
- Neue Redakteure
- Eventuelle externe Mitarbeiter
- Oder für andere Kollegen, wie Entwickler und Konstrukteure, die ebenfalls Aufgaben der technischen Dokumentation übernehmen
Denn im Redaktionshandbuch ist ganz genau festgelegt, wie der Prozess bis zur fertigen Dokumentation abläuft.
Übrigens sind nicht nur Redakteure die Zielgruppe für einen Redaktionsleitfaden. Relativ häufig sind auch Grafiker bei der Dokumentenerstellung mit involviert. Der Leitfaden legt beispielsweise fest, in welchem Stil, Format, Größe usw. die Zeichnungen erstellt werden sollen. Außerdem kann er Muster enthalten und sogar Angaben zur benötigten Software. Außerdem können im Redaktionshandbuch auch Ansprechpartner für eventuelle Rückfragen festgelegt werden.
Normalerweise sind nicht nur Redakteure sondern auch Konstrukteure und Entwickler bei der Erstellung einer Dokumentation beteiligt. Auch für diese Mitarbeiter kann ein Redaktionsleitfaden wertvolle Informationen enthalten wie:
- Wer ist für welche Aufgaben zuständig?
- Wie viel Zeit wurde für die Dokumentation eingeplant?
- Wer muss über Neuentwicklungen informiert werden?
Außerdem
Jeder technische Redakteur, jeder Konstrukteur und jeder Entwickler hat seinen ganz eigenen Schreibstil, den er auch ganz gerne mal in die Dokumentation mit einfließen lässt. Was für Artikel, beispielsweise für ein Fachblatt, noch ganz okay ist, hat aber in der technischen Dokumentation nichts zu suchen. Denn zum einen kann dadurch die Qualität sinken, und zum anderen ist die Dokumentation dann kein homogener Prozess mehr. Und das kann zu Reibereien führen. Ist der Redaktionsleitfaden erst einmal erstellt, ist er allgemeinverbindlich, auch was die Ausdrucksweise und den Schreibstil angeht. Das Redaktionshandbuch gilt übrigens für das komplette Unternehmen, also auch für eventuelle Niederlassungen im In- und Ausland. Dank eines Leitfadens kann es durchaus sein, dass die Technische Redaktion viel effizienter arbeiten kann. Alle Abläufe sind schriftlich gesichert. Es kann also kein Wissen verloren gehen, wenn ein Mitarbeiter das Unternehmen verlässt – aus welchen Gründen auch immer. Aber natürlich kann ein solches Handbuch auch Nachteile haben. Die Erstellung kann äußerst zeitaufwändig sein. Und steht ein solcher Leitfaden erst einmal, muss er natürlich auch gepflegt werden. Außerdem kann es etwas dauern, bis der Redaktionsleitfaden bei allen Mitarbeitern „angekommen“ ist, die ihn verwenden sollten. Gerade am Anfang kann es durchaus zu Irritationen kommen.
Aber erfahrungsgemäß steigt die Akzeptanz schnell, wenn ein guter Leitfaden die entsprechenden Ergebnisse bringt und allen Beteiligten die Arbeit erleichtert.
