Zehn Dinge, die ein Technischer Redakteur können sollte

Zehn_Dinge bearbeitetSie sind technischer Redakteur oder interessieren sich zumindest für technische Redaktion? Vermutlich schon, denn sonst wären Sie nicht hier. Gut für Sie. Technische Dokumentation gewinnt nämlich an Bedeutung. Hochwertige Dokumentation ist ein Qualitätsmerkmal, mit dem sich Unternehmen profilieren können. Technische Redakteure sind also gefragt. Grund genug, einmal genauer hinzusehen, was so ein technischer Redakteur eigentlich können sollte. Wir haben dazu verschiedene Blickwinkel (mit verschiedenen Erwartungen) auf den technischen Redakteur untersucht. Denn wir wollten wissen: Was denken Berufsanfänger? Wie sieht das offizielle Berufsbild aus? Und wonach suchen Unternehmen tatsächlich?

Was denken Jungredakteure, dass sie können sollten?

Nehmen wir einmal die Perspektive von Berufseinsteigern ein. Gerade angehende technische Redakteure sind noch unbeschriebene Blätter und nicht durch ihre Berufserfahrungen beeinflusst. Stellvertretend für diese Gruppe haben Theo Helmberger und ich uns Gedanken gemacht, welche Kompetenzen wir für wichtig halten. Danach haben wir unsere Gedanken zu dieser Übersicht eingedampft:

Priorität Fähigkeit
1 Selbständiges Arbeiten
2 Sicheres Deutsch
3 Teamfähigkeit
4 Grundlegendes technisches Verständnis
5 Komplexere Sachverhalte einfach darstellen
6 Ausbildung / Studium / Zertifikat
7 Freude am Schreiben
8 Kenntnisse über Standards
9 Didaktische Fähigkeiten
10 Grundkenntnisse der Redaktionssysteme

Aus unserer Sicht müsste selbständiges Arbeiten, sicheres Deutsch und Teamfähigkeit bei technischen Redakteuren hoch im Kurs stehen. Allerdings haben wir als Berufsanfänger bisher nur kleinere, unabhängig arbeitende Redaktionen kennengelernt.

Außerdem sind angehende wie erfahrene technische Redakteure dafür da, dem Auftraggeber Schreibarbeit abzunehmen. Dazu ist ein gewisses Maß an Selbständigkeit nötig. Denn die Probleme sind nur verlagert, wenn sich der Auftraggeber statt mit der Dokumentation mit externen technischen Redakteuren herumschlagen muss.

Was denkt der Fachverband, dass Technikredakteure können sollten?

rp_tekomf13_fahnen-300x254.jpg

Fachverband der technischen Redakteure: tekom.

Werfen wir einen Blick nach oben. Die tekom als der Fachverband der technischen Redakteure hat ein ausführliches Berufsbild dazu entwickelt, was einen technischen Redakteur ausmacht. Wir haben das hier einmal zusammengefasst:

Fähigkeit
Kennt juristische und normative Anforderungen
kennt Prozesse und Methoden der Informationsentwicklung
kann professionell zielgruppenorientiert schreiben
kann optisch ansprechend gestalten und layouten
kann Illustrationen und bildhafte Darstellungen erstellen
hat sprachliche Kompetenz und Fremdsprachenkenntnisse, insbesondere Englisch
hat Software-, EDV-Kompetenzen
hat interpersonelle Kommunikationskompetenz
hat einen präzisen, sorgfältigen Arbeitsstil
hat Zeitmanagement-Skills

 

Beim Vergleich der Vorstellungen des Fachverbands mit den Vorstellungen der Einsteiger fällt etwas auf. Erlernbare Fähigkeiten, die für die tekom wichtig sind, werden auch von Einsteigern als wichtig erachtet. Davon haben die Berufsanfänger vielleicht schon gehört oder in Praktika Nutzen gehabt. Mit einigen Kompetenzen, die die tekom von fertigen Redakteuren erwartet, haben Berufsanfänger aber noch nichts zu tun. Wohl deshalb werden von der tekom genannte Fähigkeiten wie Zeit- und Prozessmanagement von Einsteigern noch nicht als wichtig erachtet.

Und was erwartet der Arbeitsmarkt tatsächlich von einem Technikredakteur?

Arbeitsplatz

Für Berufsanfänger wichtig: Erwartungen am Arbeitsplatz.

Ein Merkmal von Berufsanfängern ist, dass sie irgendwann mit ihrem Beruf anfangen wollen. Daraus folgt ein Interesse für das, was potenzielle Arbeitgeber von technischen Redakteuren erwarten. Das hat uns auch interessiert und wir haben uns im Stellenmarkt nach den Anforderungen der Arbeitgeber umgesehen. Die Anforderungen haben wir gruppiert und statistisch ausgewertet. Die Essenz aus über 50 Stellenanzeigen ist ein eindeutiges Bild:

Priorität Fähigkeit
1 Technisches Verständnis
2 Sicheres Englisch
3 Erfahrung in der zu dokumentierenden Branche
4 Studium
5 Teamfähigkeit
6 Kommunikationsfähigkeit
7 Selbständigkeit
8 Ausbildung
9 Sicheres Deutsch
10 Erfahrung mit CMS

Technisches Verständnis und Branchenerfahrung sind gefragter als Team- und Kommunikationsfähigkeit. Anscheinend legen Unternehmen mehr Wert auf fachliche als auf soziale Kompetenzen. Kurioserweise wird sicheres Englisch als wichtiger als sicheres Deutsch eingeschätzt. Während die tekom allgemein von Sprachkompetenz spricht, haben Berufsanfänger vor allem das sichere Deutsch im Blick. In Deutschland sind mehrere große internationale Unternehmen tätig. Auch mit Sitz in Deutschland schreiben diese häufig ihre Dokumentation zunächst auf Englisch. Für diese Unternehmen bringt der ideale technische Redakteur deshalb Englischkenntnisse mit. Für Unternehmen, Einsteiger und tekom gleichermaßen wichtig ist, dass die Handwerkszeuge ordentlich beherrscht werden.

Kleinste gemeinsame Nenner

Vergleichen wir die Vorstellungen von Einsteigern, tekom und dem Arbeitsmarkt über das, was einen technischen Redakteur ausmacht. Es gibt drei erkennbare Kompetenzen, die von allen für so wichtig gehalten wurden, dass sie Erwähnung fanden.

Selbständiger Arbeitsstil

Zum perfekten technischen Redakteur gehört ein selbständiger Arbeitsstil. Die tekom wird noch etwas präziser. Zum selbständigen Arbeiten muss man sich die Zeit einteilen können und sorgfältig arbeiten.

Sprachliche Kompetenz

Deutsch sollte der technische Redakteur beherrschen. Englisch wird nur von Einsteigern nicht genannt. Das liegt vielleicht daran, dass Einsteiger nur selten mit englischsprachiger Dokumentation in Berührung kommen. Manchmal treiben es Unternehmen noch weiter und wünschen sich Sprachen wie Französisch, Italienisch oder Spanisch.

Beherrschte Handwerkszeuge

Unternehmen wie Anfänger denken, dass technische Redakteure zumindest erste Erfahrungen mit Content-Management- oder Redaktionssystemen haben sollten. Die tekom gibt sich damit nicht zufrieden. Nach ihren Vorstellungen sollten technische Redakteure auch kompetent im Umgang mit anderer Software sein.

Diese drei Kompetenzen sollte jeder technische Redakteur mitbringen. Daneben gibt es noch eine ganze Reihe weiterer Kompetenzen, die den idealen technischen Redakteur ausmachen. Welche das sind, das hängt vom Blickwinkel ab. Je nachdem, aus welcher Ecke man auf den technischen Redakteur schaut, ändert sich sein Profil. Und welche Fähigkeiten sind aus ihrem Blickwinkel besonders wichtig? Welche Erfahrungen haben Sie gemacht?

Hilfe, die Praktikanten sind da!

Korbinian Geiger (23, Bild links) und Korbinian+TheoTheo Helmberger (28, Bild rechts) unterstützen zurzeit als Praktikanten seit dem ersten Oktober respektive zweiten November die technische Redaktion im unserem Haus. Wir haben sie gebeten, kurz über ihr Praktikum zu berichten.

Wie seid ihr zu uns gekommen?

Korbinian: Ich studiere technische Redaktion und Kommunikation im fünften Semester an der Fachhochschule München. Das fünfte Semester ist wie bei vielen Studiengängen an der Fachhochschule ein Praxissemester. Die große Aufgabe des letzten Semesters vor den Sommerferien (in denen erfahrungsgemäß für das Studium wenig bis nichts passiert) war also, einen Praktikumsplatz zu finden. Mein erster Weg führte mich zu den Stellenanzeigen – in der Hoffnung, dort fündig zu werden. Die Hoffnung erfüllte sich und unter den Unternehmen kam mir ein Name bekannt vor: doctima. Den habe ich doch schon mal gehört. So war es auch – in meinem Studium bin ich während der Recherchen zu einer Präsentation auf diesen Blogbeitrag über die Bedeutung von Zielgruppen gestoßen. Deshalb habe ich mich entschieden, mein Praktikum bei doctima zu machen.

Theo: Im Gegensatz dazu bin ich Quereinsteiger im Bereich Technische Redaktion. Nach meinem Magisterabschluss in Japanologie letztes Jahr war ich auf der Suche nach einem für mich passenden Beruf. Trotz vieler Ideen und Empfehlungen (wie dem Klassiker „Irgendwas mit Japan“) entschied ich letztendlich, dass es mit „Dinge erklären“ zu tun haben sollte. Ich liebe es Dinge/Konzepte/Sachverhalte zu erklären. Von einem früheren Treffen mit Katrin Thurnhofer erinnerte ich an ihre Firma, die mit – genau passend – „irgendetwas mit Sachen erklären“ zu tun hat. Also habe ich zum Hörer gegriffen und mir erst einmal erklären lassen, was es denn mit dieser Technischen Dokumentation auf sich hat. Zu Zeit meiner Anfrage war Korbinian gerade in einem auswärtigen Kundenprojekt beschäftigt und die Redaktion gleichzeitig mit Arbeit überlastet, aber eben de-facto ohne Praktikant. Daher hat es sich für beide Seiten angeboten, dass ich an meine telefonische Kurzeinführung ein Praktikum anschließe.

Was macht ihr bei uns? Welche Aufgaben habt ihr?

Theo:  Durch mein fehlendes Wissen über Technische Redaktion und den Zeitdruck zu Beginn meines Praktikums bedingt, bestanden meine Aufgaben in den ersten Wochen hauptsächlich aus Korrekturlesen. Trotz meiner Vorkenntnisse als Geisteswissenschaftler habe ich dabei jedoch noch einiges über das Thema Lektorat gelernt. Erst nach der Lastspitze war dann Zeit für eine Einarbeitung in ST4, Content-Management und ähnliche Gegenstände der Technischen Redaktion. Die Contentpflege eines überarbeiteten maschinenübergreifenden Bedienungskapitels – ein Großprojekt das selbst nach 2 Jahren noch nicht abgeschlossen ist – ist zum Beispiel größtenteils meine Aufgabe. Zusätzlich habe ich zudem bei der Vorbereitung für die Tekom-Jahrestagung und der Weihnachtsaktionen mitgeholfen.

Korbinian: Bei mir Verschiedenes. Anfangs waren die Arbeiten die üblichen Verdächtigen wie Formulare kopieren, Bibliotheksverwaltung, Recherchearbeiten und unkritischen Kleinkram. Theo hat bereits die Arbeit beim Kunden erwähnt, der mit den Inhalten seiner sehr umfangreichen Internetseite umgezogen ist. Nach meiner Rückkehr sind es aber hauptsächlich Arbeiten aus dem Bereich der technischen Dokumentation. Dazu gehören die Nachformatierung von maschinell produzierten Dokumenten, Lektorate und Transfer von Fremddokumentation.

Wie lange musstet ihr euch einarbeiten?

Theo: Nach etwa einer Woche war ich größtenteils akklimatisiert. Was die Aufgaben angeht, so konnte ich vom ersten Tag an mithelfen. Die Kollegen hier sind sehr gut darin die Aufgaben so aufzuteilen und benötigtes Wissen mitzuliefern, dass für jedes Level an Vorkenntnissen etwas dabei ist. Allerdings gab es auch nach 4 Monaten noch neue Sachen zu lernen, wenn eine neue Aufgabe anstand. Dadurch dass man als Praktikant zwischen Projekten wechselt, ist immer irgendetwas anders.

Korbinian: Es vergingen drei bis vier Tage, bis ich einzelne einfache Aufgaben ohne Nachfragen bearbeiten konnte. Als Frischling musste ich mich zuerst in der Netzwerkumgebung und in den internen Wissenspoolen zurechtfinden. Aber bevor ich davon irgendetwas sehen konnte, hat sich Johannes Dreikorn die Zeit genommen und mit mir zusammen die Arbeitsumgebung eingerichtet. Einige Fragen haben sich dann nach einem Blick in den internen Wissenspool geklärt, für manche Dinge muss ich aber immer noch nachfragen, zum Beispiel dann, wenn es um projektspezifische Corporate Designs oder ähnliches geht. Inzwischen läuft die Beseitigung von Unklarheiten aber nebenher, sodass ich mich auf die Arbeit konzentrieren und dabei noch Spaß haben kann.

Macht euch die Arbeit hier eigentlich auch Spaß?

Korbinian: Hier kann sich jeder seine Zeit frei einteilen. Wir arbeiten in Gleitzeit. Natürlich gibt es eine ungefähre Terminplanung, aber jeder entscheidet selbst, wann was bearbeitet wird und wann Pause ist. Es gibt immer was zu tun, man sitzt nie seine Zeit ab. Meistens steht irgendeine Recherchearbeit an, die nicht zeitkritisch ist und im Hintergrund läuft. Abgesehen von der Arbeit ist niemand, den ich bisher kennengelernt habe (und das sind nach vier Monaten doch einige), unfreundlich. Das „Du“ ist hier das Normalste der Welt. Als technische Redaktion ist die doctima auch ein Hort für Leute, die etwa auf der gleichen Wellenlänge sind und so kommt es, dass sich die Gespräche nicht immer um Verben, Texte und Dokumentation drehen, sondern auch mal um die neuesten Filme, Spiele oder Serien. Nicht zu vergessen der ‚Leberkas-Express‘. Falls jemand mittags zum Bäcker oder Metzger fährt, dann wird vorher rumgefragt, ob noch jemand etwas haben will.

Theo: Das stimmt, die Gleitzeit trägt maßgeblich dazu bei. Ansonsten würde ich neben der interessanten und erfüllenden Arbeit auch die Büroräume und das allgemeine Arbeitsklima anmerken. In einem hellen, offenen Büro wie diesem ist es nicht schwer sich wohl zufühlen und die gut ausgestattete Küche trägt ihr Übriges dazu bei. Frotzeleien zwischen IT und Redaktion (Ja, liebe IT, ich esse nunmal langsam!) oder nachmittägliche Blödeleien sorgen zusätzlich für eine lockere Atmosphäre.

Wie ist für euch unsere räumliche Erreichbarkeit?

Korbinian: Die doctima liegt etwas außerhalb der Stadt in einem neu angelegten Industriegebiet. Es kommt also auch frische Luft rein, wenn das Fenster geöffnet wird. Mit dem Bus bräuchte ich etwa eine halbe Stunde von der Innenstadt bis zur doctima. Meistens fahre ich aber mit dem Fahrrad. Der Weg zur doctima führt über Fahrradwege oder ruhige Straßen und ist mit fünf Kilometern nicht übermäßig lang. Sehr wichtig: Obwohl die doctima etwas außerhalb liegt, gibt es für den Hunger zwischendurch in vier Fahrradminuten einen Rewe mit Bäcker und Döner und in fünf Fußminuten die gute Kantine des Fraunhofer-Instituts.

Theo: Für mich verhält es sich ähnlich, da ich auch mit dem Fahrrad komme. Daher finde ich es auch sehr gut dass man Fahrräder im Haus abstellen kann. Der Rewe liegt zudem direkt auf meinem Heimweg und ist somit sehr praktisch wenn man erst um halb acht Uhr abends aus dem Büro kommt (was ich Langschläfer gerne tue).

Was könnt ihr aus eurer Zeit bei uns mitnehmen?

Theo: Mein hauptsächlicher Wissensgewinn erstreckt sich auf die Grundlagen der Technischen Redaktion (Was ist Sinn und Zweck/Ziel der TR und wie wird dieses erreicht) und die Erkenntnis, dass ich in diesem Beruf arbeiten möchte. Darauf aufbauend habe ich die verschiedenen Möglichkeiten in den Beruf einzusteigen gelernt (Studium, berufsbegleitende externe Weiterbildung, Weiterbildung in Vollzeit, berufsbegleitendes Studium, Ausbildung, Tekom-Volontariat). Zudem hat mir meine Zeit hier gezeigt, wie wertvoll nicht TR-bezogenes Wissen sein kann: Der „andere Blickwinkel“ ist nicht zu unterschätzen. Darüber hinaus weiß ich jetzt mehr über die Struktur von Anleitungen und Arbeitsabläufen, Grundlagen in InDesign und Photoshop sowie XML und ST4.

Korbinian: Mir als Student im Praxissemester war natürlich wichtig, das Gelernte auch praktisch anzuwenden. Was ich im Studium über Word, InDesign, Terminologie und allgemein über Content-Management-Systeme gelernt habe, das hat sich in der Praxis als nützlich herausgestellt. Was ich im Studium nicht gelernt habe, das ist der tägliche Arbeitsablauf eines Redakteurs. Zur Redaktion gehört eben nicht nur Schreiben, sondern auch Zeitmanagement, Verwaltung und der Informationsaustausch mit anderen Redakteuren und mit Kunden. Mitgenommen als allgemeine Weisheit habe ich, dass Verbesserungsvorschläge auch von Praktikanten durchaus erwünscht sind und man keine Scheu haben sollte, sich einzubringen.

Wir möchten am Schluss noch für die tolle Zeit in eurer Firma danken! Hoffentlich ist unser Abschied keiner für immer.

Standardsammlung ohne Standardkost

Fünf Standards, viel Wissen, kein Vergleich

Wer technischer Redakteur, Verantwortlicher für die Einführung eines CMS, Quereinsteiger oder überhaupt an standardisierter und strukturierter Information interessiert ist, der soll mit „Standardisierungsmethoden für die technische Dokumentation“ gut bedient werden. Das Werk ist eine Hilfestellung für alle, die auf der Suche nach einer Methode zur Standardisierung ihrer Dokumentation sind. Werk sage ich bewusst, denn es handelt sich nicht um ein Buch, sondern um eine Sammlung von Aufsätzen, die von Experten oder Entwicklern der jeweiligen Standards verfasst wurden.

Amüsanter Anfang und lockeres Lernen

Geschichte mal anders: Mitreißender Informationsstrom statt öder Textwüste

Die ersten Zeilen lassen mich allerdings schmunzeln. Statt des erwarteten ernsthaften Textes überrascht ein unterhaltsamer Einstieg von Jürgen Muthig zur Vorstellung von Firmenstandards als Eigenentwicklung. Er ist gespickt mit humorvoller und anschaulicher Bildsprache, ohne lächerlich zu wirken oder mich als Einsteiger in meiner Wahl zu beeinflussen. Manfred Krüger und Wolfgang Ziegler schaffen es, den unterhaltsamen Stil der ersten Seiten weiterzuführen. Statt trockener Textwüsten über die Geschichte der Standards folgt ein ansprechender und kurzweiliger Fluss von Informationen. Nebenbei erhalte ich so solides Hintergrundwissen, das mir bei der Einschätzung der danach folgenden Expertenaufsätze hilft. Durch die Ansprache mit „wir“ ist der Text kein endloser Monolog und ich kann der zeitlichen Entwicklung von SGML und CALS über HTML und DocBook zu S1000D, DITA und weiteren modernen Standards gut folgen. Der Geschichtsteil hat auch einige Überraschungen parat: Zum Beispiel plaudert Ziegler ganz nebenbei aus dem Nähkästchen über den von ihm entwickelten Firmenstandard DOCU für Liebherr.

Eine bunte Mischung aus Expertenwissen

Sammelband: Vom Lehrbuch bis zur Werbebroschüre alles vertreten

Sammelband: Vom Lehrbuch bis zur Werbebroschüre alles vertreten

An manchen Stellen stößt das Konzept eines Sammelbandes leider an seine Grenzen. Die Autoren (Muthig/Schäflein-Armbruster, Closs, Lehrndorfer/Reuter, Juhl, Böhler) kommen auf sehr unterschiedlichen Wegen zur technischen Redaktion und unterscheiden sich in ihrem Schreibstil. Das schlägt sich auch in der Sammlung nieder. Die einen schreiben pistolenartige Kurzsätze, die anderen stapeln Schachtelsätze. Manche Aufsätze lesen sich wie eine Werbebroschüre, andere dagegen wie ein Lehrbuch. Ein wirklich objektiver Vergleich kann konzeptbedingt nicht stattfinden – kein Experte wird den Standard schlechtreden, für den er sich entschieden hat, und kein Entwickler das verreißen, was er selbst mühsam aufgebaut und verbreitet hat. Vergleichen muss der Leser deshalb selbst.

Entscheiden muss ich selbst

Wegfindung: Viele Standards führen zum Ziel

Wegfindung: Viele Standards führen zum Ziel

Die Entscheidung, welcher Standard für mich geeignet ist, wird mir nicht abgenommen. Aber sie wird mir erleichtert: So unterschiedlich die Stile der Autoren auch sein mögen, so wenig auch verglichen wird – jeder Aufsatz erklärt genau, wie der vorgestellte Standard funktioniert, für welche Einsatzzwecke er geeignet ist und erklärt die Hintergründe und Anwendung des Standards. Jeder Experte, der zu Wort kommt, macht deutlich, dass er ein Experte ist und vermittelt das Wissenswerte zu „seinem“ Standard. Die meisten von ihnen liefern auch eine Zusammenfassung für Eilige mit. Erfreulich ist, dass der Sammelband trotz des mehrfachen Aufgreifens derselben Themen in der Einführung und im dazu passenden Aufsatz nicht repetitiv ist – oder es zumindest schafft, nicht so zu wirken. Wer mehr wissen möchte, der wird im Werk ebenfalls fündig: Literaturangaben zu den jeweiligen Aufsätzen bieten eine Anlaufstelle zum Weiterlesen und das Autorenverzeichnis erleichtert die Kontaktaufnahme.

Gescheiterte Standards gibt es nicht

Das Schlusswort des Intros beschreibt in etwa den Eindruck, den die Sammlung von Expertenschriften bei mir hinterlassen hat. Das größte Problem eines Standards ist die Marktdurchdringung. Alle Standards haben ihre Berechtigung, einen gescheiterten Standard gibt es nicht. Was zu meinen Anwendungszwecken passt, wird übernommen. Und was nicht ganz passt, wird passend gemacht oder nur teilweise übernommen (dafür haben Krüger und Ziegler das schöne Wort „Steinbruchnutzung“ gefunden).

Sinn und Zweck der Aufsatzsammlung ist es, einen Überblick über einige der etablierten Standards in der Technischen Dokumentation zu bekommen. Ein Vergleich findet nicht statt. Das hat den Vorteil, dass ich unvoreingenommen an meine Auswahl gehen kann. Das hat aber gleichzeitig auch den Nachteil, dass mir etwaige Schwierigkeiten erst nach meiner Entscheidung auffallen können. Denn die Experten erwähnen Probleme oder Schwächen bei der Einbindung „ihrer“ Standards in Technische Dokumentation nicht. Dazu sollte man andere Werke zu Rate ziehen, die auch explizit die Schwächen mit in den Vergleich einbeziehen. Trotzdem servieren die Autoren eine Menge mundgerecht aufbereitetes Wissen, das bei der Beurteilung hilfreich ist. Nebenbei erfährt man – gerade als Einsteiger wie ich – bei der Lektüre Dinge, die einen vorher vielleicht interessiert haben, für einen technischen Redakteur aber nicht unwichtig sind. Zum Beispiel hat OpenOffice bereits vor Word eines der heute meistgenutzten Datenaustauschformate genutzt: XML. Das war für mich neu. Für Sie auch?

Literatur: Jürgen Muthig (Hrsg.): Standardisierungsmethoden für die Technische Dokumentation (2008). Verlag Schmidt-Römhildt, Lübeck, 167 Seiten. ISBN 978-3-7950-7066-3

Hinweis: Das hier besprochene Buch wurde uns vom Verlag kostenfrei als elektronisches Rezensionsexemplar zur Verfügung gestellt. Der Verlag hat keinerlei Einfluss auf den Inhalt dieser Besprechung genommen.

Wie wenig ist genug? – Rechtskonforme Dokumentation im Maschinen- und Anlagenbau

Querbeet durch die Technische Dokumentation im Maschinen- und Anlagenbau.

Querbeet durch die Technische Dokumentation im Maschinen- und Anlagenbau.

Hersteller müssen ihre Produkte rechtskonform machen. Neben dem Produkt selbst gehört dazu auch die Dokumentation. Dafür möchten sie so wenig Aufwand wie möglich betreiben. Doch wie wenig darf es werden und wie viel muss sein? Was braucht meine Dokumentation, um rechtlich auf sicheren Füßen zu stehen? Und wie kann meine Redaktion effizient und trotzdem sicher und konsistent schreiben? Antworten darauf will das Buch auf meinem Tisch geben: „Technische Dokumentation im Maschinen- und Anlagenbau“ von Heinz Schlagowski.

Für wen soll das Buch sein?

Das Buch will mich ansprechen und „alle, die mit technischer Dokumentation zu tun haben“. Das ist sehr breit gefächert und macht es dem Autor nicht einfacher – haben wir als technische Redakteure doch ganz anderes Fachwissen als der Laie, der sein Produkt auf den Markt bringen möchte und für das Drumherum wenig übrig hat. Das Buch will erklären, warum das Drumherum für rechtssichere Produkte weit mehr ist als nur eine lästige Pflicht.

Was liefert das Buch?

Gleich so viel: Nach dem Lesen werde ich mit einer Fülle an Informationen belohnt, die nicht nur den Technischen Redakteur, sondern auch den Hersteller eines Produktes ansprechen soll. Allerdings bläht diese Informationsfülle das Buch auch auf 700 Seiten auf, die gelesen werden wollen und größtenteils aus Text bestehen.

Europäische Gemeinschaft: Gesetze und Grundlagen für Produkte
Warum interessieren sich Entscheider zunehmend für das Thema technische Dokumentation – oder wären gut beraten das zu tun? Ich als angehender Technischer Redakteur weiß natürlich warum technische Dokumentation wichtig ist (schließlich habe ich diesen Weg nicht zufällig eingeschlagen) und erfahre in diesem Teil nichts Weltbewegendes. Aber wer neu oder quer einsteigt weiß nach diesem Teil des Buches ebenfalls warum diese Arbeit wichtig und sinnvoll ist.

Der Entscheider im Unternehmen weiß das vielleicht noch nicht und versteht durch die Vermittlung der rechtlichen Grundlagen und Vorschriften, warum konsistente und gute technische Dokumentation ein Thema ist, das Aufmerksamkeit verdient hat.

Normen und Richtlinien als „Stand der Technik“
Wenn ein Hersteller eine Maschine produziert oder ich die Dokumentation dazu schreibe, dann muss das nach dem „Stand der Technik“ erfolgen. Was das genau heißt, können der Hersteller und ich im Bereich der Normen und Richtlinien nachlesen. Das Buch klärt uns auf was getan werden muss, um Maschine und Dokumentation auf den Stand der Technik zu bringen. Dass der Autor das Thema sehr ernst nimmt erklärt auch, warum das Thema das halbe Buch in Anspruch nimmt.

Während der Hersteller von den VDI-Richtlinien angesprochen wird, sind für mich die tekom-Leitfäden ein nützliches Handwerkszeug für den Alltag in der Redaktion. Auszugsweise Abschnitte und Erklärungen unter anderem aus der Maschinenrichtlinie und einigen DIN-Normen wie dem Klassiker 82079 helfen mir zu verstehen, was die manchmal sehr schwammigen Normen aus unserem Schrank eigentlich aussagen wollen. Der Entscheider versteht, welche Dokumente ich für meine Dokumentation brauche und kann die Kommunikation mit anderen Abteilungen fördern.

Sicher ist sicher
Sicherheit ist wichtig für denjenigen, der meine Dokumentation zu lesen bekommt. Damit sicher auch wirklich sicher und rechtskonform ist, präsentiert mir Herr Schlagowski die Informationen, die die Normen und Richtlinien enthalten, nochmals in einem separaten Kapitel. Dazu bekomme ich genaue Instruktionen zur Gestaltung – praktisch, da ich sofort anfangen kann, die Theorie in die Praxis umzusetzen.

Der rote Faden für die Dokumentation
Um individuelle Redaktionsleitfäden erstellen zu können, liefert das Buch einige Hinweise zur Entwicklung von Redaktionsleitfäden und betont, warum diese sinnvoll sind.

Wenn ich in die Situation kommen sollte einen Leitfaden für eine Redaktion schreiben zu müssen, dann kann ich auf das Kapitel „Redaktionshandbuch“ zurückgreifen. Hier wird mir genau erklärt, warum ein Redaktionsleitfaden nützlich ist und wie man zu einem guten Redaktionsleitfaden kommt. Das Kapitel enthält aber keine Mustervorlage oder Beispiele für einen Redaktionsleitfaden. Die Schreib- und Recherchearbeit nimmt einem der Autor also nicht ab.

722015_original_R_K_B_by_Tim Reckmann_pixelio.de

Damit der Leitfaden nicht zum Kuddelmuddel wird: Kapitel Redaktionsleitfäden
(Bild: Tim Reckmann / pixelio.de)

Für einen potenziellen Auftraggeber ist dieser Teil uninteressant, denn ihn interessiert weniger, wie ich arbeite, sondern was dabei herauskommt.

Hilfe zur Selbsthilfe
Wie ein Redaktionsleitfaden aussehen kann, wird mir im nächsten Kapitel klarer, das mit Beispielen aus einem Redaktionsleitfaden gewürzt ist, die zusätzlich noch mit Erklärungen versehen sind. Als Inspirationsquelle ist dieses Kapitel sehr gut geeignet und für Neueinsteiger sind die fertigen Bausteine sehr praktisch.

Das Kapitel liefert aber noch mehr. Der Betreiber der dokumentierten und ausgelieferten Maschine hat auch einige eigene Dokumentationspflichten. Um diesen nachzukommen benötigt er weitere Informationen. Der informierte Hersteller weiß nach diesem Kapitel, welche Informationen das sind und kann diese gleich mitliefern.

Mehrere Maschinen sind eine Anlage
Das Schlusskapitel erklärt, wie aus der Maschine eine Anlage wird und welche Regeln dann für den Hersteller und meine Dokumentation gelten. Anhand des Kapitels können Entscheider festlegen, ob es sich um eine Anlage handelt und welche Einzeldokumente wie vorliegen müssen, um eine funktionale Gesamtdokumentation zu erzeugen.

Für wen ist das Buch tatsächlich geeignet?

Dem Anspruch „allen, die mit technischer Dokumentation zu tun haben“ wird das Buch gerecht, es waren nicht nicht nur für mich interessante Abschnitte im Buch.

Besonders die konkreten Hilfen zur Erstellung eines Redaktionsleitfadens und die Gestaltungsvorschläge für Sicherheitshinweise haben mir gefallen.

Die Entscheider im Unternehmen wissen nach dem Lesen des Buches, warum sie unseren Beruf wertschätzen sollten und wie sie ihren Käufer auch nach dem Kauf bei seinen Dokumentationspflichten unterstützen können.

Rundumschlag mit großem Umfang

Allerdings erfordert das Buch dazu auch 700 Seiten und hat mich daher im ersten Moment eher abgeschreckt. Es kann als Universalbuch auch nicht in dieselbe Detailtiefe wie Fachliteratur gehen. Als Universalbuch ist „Technische Dokumentation im Anlagen- und Maschinenbau“ von Heinz Schlagowski geeignet, als Nachschlagewerk für Detailfragen weniger, da mich nicht jedes Kapitel angesprochen hat und ich reichlich oft mit Umblättern beschäftigt war. Hier bevorzuge ich spezielle Literatur, die genau auf die Technische Redaktion zugeschnitten ist.

Literatur: Heinz Schlagowski (Autor): Technische Dokumentation im Maschinen- und Anlagenbau (2., überarbeitete Auflage 2015). Beuth Verlag GmbH, Berlin/Wien/Zürich, 749 Seiten. ISBN 978-3-410-25157-6

Hinweis: Das hier besprochene Buch wurde uns vom Verlag kostenfrei als Rezensionsexemplar zur Verfügung gestellt. Der Verlag hat keinerlei Einfluss auf den Inhalt dieser Besprechung genommen.