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.

DITA und Deutschland – eine Antwort an die Redakteuse

Warum weht in Deutschland bei DITA ein anderer Wind? (c) lichtkunst.73 / pixelio.de

Warum weht in Deutschland bei DITA ein anderer Wind?
(c) lichtkunst.73 / pixelio.de

Im Nachgang zur #tekom15 hat Marijana Prusina hier die Diskussion auf der Tagung und ihre Gedanken zu DITA zusammengefasst. Unser Kommentar dazu.

Deutschland zu zögerlich? Ich denke eher nicht. Ich sehe den wichtigen Punkt eben doch darin, dass in Deutschland schon lange sehr leistungsfähige CCMS auf dem Markt sind.

Denn das heißt zunächst einmal: Alle early adopter haben sich frühzeitig damit beholfen.

Zweite Konsequenz: Die Unternehmen, die bisher bei unstrukturierten Workflows geblieben sind und bei denen DITA eine Lösung wäre, treffen auf einen Markt, auf denen DITA eine Lösung unter mehreren mächtigen Standards ist. Denn nur weil DITA eine Lösung wäre, heißt das ja nicht, dass ein CMS keine sein kann.

Drittens: Es gibt außerdem auch etliche Fälle, bei denen Unternehmen von DITA wegmigrieren. Auch das hält den Markt für DITA in Deutschland schlanker.

Und Viertens: Vielen Redakteure in Deutschland mit denen ich gesprochen habe, geht DITA schlicht und einfach auf die Nerven. In jedem zweiten internationalen Vortrag zu DITA wird zumindest angedeutet, dass die Redakteure in Deutschland sagen wir mal zu dumm sind zu verstehen, was DITA leistet. Zunächst ist das ja ohnehin schon keine besonders clevere Verkaufsstrategie. Und wenn ich die Argumente pro DITA dann schon in identischer Form seit mehreren Jahren von den CMS-Herstellern kenne, dann wirkt der DITA-Promoter auf mich nicht sonderlich kompetent.

DITA ist (genau wie CMS) immer nur so gut, wie die Leute damit arbeiten. Wir bei doctima haben in unseren Migrationsprojekten aus DITA schon die erstaunlichsten Fälle von Missbrauch erlebt. Leider versäumen viele Kunden von DITA (ebenso wie von CMS) ihre Redakteure auch redaktionell für strukturierte Schreibprozesse zu qualifizieren. Und dann hilft das beste System nichts…

World Leaders schreiben besser?

Die Autori des Beitrags, Kristina PelikanHeute begrüßen wir Kristina Pelikan als Autorin in unserem Blog. Am Schweizerischen Tropen- und Public Health – Institut in Basel widmet sie sich u. a. internationaler und interkultureller Projektkommunikation, als wissenschaftliche Mitarbeiterin der TU Berlin gehören Fachsprachen zu ihren Schwerpunkten – beide Themen verbindend promoviert sie als Sprachwissenschaftlerin zu Kommunikationsoptimierung.  Außerdem beschäftigt Sie sich damit, wie Wissenschaftler in internationalen Teams zusammen Dokumente erstellen…

Besprechung am Laptop

(c) K. Pelikan

Chausiku kommt aus Rukungiri und sitzt vor einer schwierigen Aufgabe.
Letztes Jahr hat sie in Uganda ihr Studium in Sozialwissenschaften erfolgreich abgeschlossen, und nun soll sie einen Text für den internen Newsletter eines Forschungsprojektes schreiben. Manche Texte dieses Newsletters werden auf der Projektwebseite veröffentlicht, was den Kreis der Rezipienten erweitert und Chausikus Druck erhöht. Wie soll sie diesen Text schreiben?
Chausiku arbeitet in einem Forschungsprojekt, das von Mitgliedern einer medizinischen Fakultät in Belgien geleitet wird, und an dem knapp 100 Projektmitglieder in sechs Ländern zusammen am Zugang zu bestimmten Medikamenten arbeiten. 11 verschiedene Muttersprachen und 9 verschiedene Fachrichtungen sorgen für eine sprachliche Heterogenität, der mit English als Lingua Franca begegnet wird. Wie schreibt Chausiku also nun diesen Text? Schreibt sie ihn alleine?

Collaborative Writing – das bedeutet?

Chausiku schickt ihren Entwurf der in der Schweiz arbeitenden Leiterin ihrer Arbeitsgruppe „Knowledge Management and Communication“, bevor er im nächsten Skype-Meeting mit dem gesamten Team besprochen wird. Die Arbeitsgruppe besteht aus mindestens einem Mitglied je Partnerinstitut – mit verschiedenen Muttersprachen und Fachsprachen. Chausikus Artikel wird somit sowohl von einem indischen Experten für ayurvedische Medizin als auch von einer britischen Politikwissenschaftlerin kommentiert. An jedem Text dieses Newsletters wird im Team gearbeitet – collaboratively. Collaborative Writing ist jedoch nicht gleich Collaborative Writing – Farkas nennt unterschiedliche Varianten, die Chausiku alle aus ihrem Projekt kennt.  Farkas 1991

Frau am Schreibtisch

(c) K. Pelikan

Bei Chausikus Projekt treffen sich die Projektmitglieder zu sogenannten „Writing Workshops“, um gemeinsam an Publikationen zu schreiben, sie arbeiten virtuell per Skype, Wiki oder Forum in Teams zusammen – zusätzlich zu „Local Meetings“ der Mitglieder nur eines Partnerinstitutes. Also arbeiten sie in unterschiedlichen Zusammensetzungen und mit unterschiedlichen Kommunikationsmedien gemeinsam an ihren Forschungsfragen und Publikationen – gefolgt von Diskussionen über Intellectual Property und Authorship.
Kollaboratives Schreiben ist jedoch nicht nur ein Austausch von Ideen, sondern auch ein Austausch von Skills in den Bereichen Fremdsprache, Fachsprache und wissenschaftliches Schreiben selbst. Chausiku hat in Uganda Sozialwissenschaften studiert und ihr Studium mit Auszeichnung abgeschlossen – die Zusammenarbeit in so einem heterogenen Team hat sie jedoch nie gelernt. Sie wird sie nun lernen – learning by doing!

We had world leaders!

Auf die Frage, warum es für die Mitarbeiter seiner Projekte bisher kein Training im Bereich Kommunikation oder wissenschaftliches Schreiben gab, war „we had world leaders“ die Antwort eines international renommierten Projektleiters. Fachkompetenz impliziert Schreibkompetenz im interkulturellen Umfeld. Somit ist auch Chausiku als wissenschaftliche Mitarbeiterin, die gerade in Uganda vor ihrem Text sitzt, ein World Leader?
Englisch kann ja eh jeder! Ab einem gewissen Bildungsniveau wird verhandlungssicheres Englisch vorausgesetzt. Nicht immer muss diese Varietät des Englischen dem Englisch eines Muttersprachlers gleichen – ist doch „Pseudoenglisch“ die neue Sprache Europas (Die Welt 2015) und auch außerhalb Europas anerkannt. Capacity Building in diesen Bereichen gibt es also in sehr vielen internationalen Forschungsprojekten in den Naturwissenschaften nicht.

… und das geht in so einem heterogenen Team?

Teamwork und effiziente Kommunikation sind das A und O in solchen Projekten. Selbstverständlich gibt es bei dieser sprachlichen Heterogenität
Verständnisschwierigkeiten und auch andere Hürden zu effizienter Kommunikation. Manche dieser Hürden lassen sich überwinden, wie Beispiele aus einem Forschungsprojekt zeigen (Pelikan 2015) . Chausiku kennt sich mit dem Thema ihres Artikels sehr gut aus – möchten die Projektleiter in Belgien den Text auch schön bunt haben, so wie sie es mag? Hier beseitigen einheitliche Templates für bestimmte Dokumente so manche interkulturelle Diskussion über afrikanisch-bunte versus europäisch-schlichte Texte – werden sie entsprechend erstellt und eingesetzt. Auch eine einheitliche Terminologie, ein projektspezifisches Corporate Wording, kann erheblich zur Verständlichkeit beitragen. Wird dieses nicht bewusst eingesetzt, kann sich ein projektspezifischer Fachwortschatz unter der Hand selbst entwickeln (Pelikan/Roelcke 2015) , der einen Teil der Funktionen eines Corporate Wordings übernimmt. Weiter erleichtern klar definierte Prozesse die Kommunikation – insofern sie in ein Kommunikationskonzept integriert sind, das dem Ansatz der integrierten Kommunikation folgt.

Training für World Leaders?

UAP Better. Simple. Life

(c) K. Pelikan

In der Wissenschaft wird Kommunikation nicht selten mit Dissemination, der Kommunikation von Forschungsergebnissen nach außen, gleichgesetzt. Die dabei oft vernachlässigte interne Kommunikation und auch das gemeinschaftliche Schreiben benötigen jedoch mehr Beachtung – und die Mitarbeiter ein entsprechendes Training: Chausikus Text wäre längst fertig! Tools ersetzen keine Skills: Chausiko hatte noch nie ein DMS gesehen, nun soll sie im dort integrierten Blog ihre Arbeit dokumentieren und sich im Diskussionsforum beteiligen. Schließen die Kollegen von Fachsprache auf Fachkompetenz? Aber auch Kollegen anderer Fachrichtungen sollen ja ihre Beiträge verstehen. Also schreibt sie besser nicht nur medial sondern auch konzeptionell schriftlich, dabei möglichst verständlich und verzichtet auf Emoticons? Auch solche Skills müssen erlernt werden.
Steigerung der Effizienz durch entsprechendes Training der Mitarbeiter und Optimierung der involvierten Prozesse, das sollte in Wissenschaft und Wirtschaft Usus sein. Kommunikationskonzepte sollten also nicht nur erstellt, sondern auch entsprechend in Schulungen vermittelt werden. So lassen sich auch Ansätze zur Kommunikationsoptimierung einfacher umsetzen – alle Mitarbeiter ziehen am gleichen Strang. Gerade World Leader mit hohen Zielen und engem Zeitplan sollten in diesem Bereich auf die Effizienz ihrer Arbeit und der ihrer Teams achten.

Es lebe die Heterogenität

Corporate Wording, Lingua Franca, Lexikalisches Leveling… Alles soll möglichst einheitlich sein – ganz im Sinne der Verständlichkeit und somit der Effizienz. Auf der sprachlichen Ebene hat dieser Ansatz durchaus seine Berechtigung. Auf der  inhaltlichen Ebene überragt der Nutzen der Heterogenität. Verständlichkeit ist essentiell – aber woher weiß Chausiku, was der aus Polen stammende und in Belgien arbeitende Kollege versteht? Die Leiterin der Kommunikationsarbeitsgruppe ist als Sprachwissenschaftlerin sehr gut mit Makro- und Mikrostrukturen von Texten für Newsletter vertraut – der Kollege aus Indien hilft ihr beim Inhalt des medizinischen Fachtextes. Aus der Heterogenität der einzelnen Arbeitsgruppen lässt sich signifikanter Nutzen ziehen – sowohl in der Kommunikation, als auch in der wissenschaftlichen Zusammenarbeit. Das geht ausgezeichnet über die Distanz von vielen Tausend Kilometern. Die virtuelle Zusammenarbeit hat viele Vorteile – bereits beim gemeinsamen Brainstorming beginnend.

 

Frische Luft gegen rauchende Köpfe

Schreibimpulsfächer

Schreibimpulsfächer (c) Budrich Verlag

Heute habe ich meine Schreibblockade einfach weggefächert. Statt einen unhandlichen Ratgeber nach Tipps zum Schreiben zu durchforsten, habe ich zum „Schreibimpulsfächer“ gegriffen. Der Markt für Ratgeber-Literatur zum Schreiben und Texten ist ja voll von Sachbüchern, die Abhilfe bei Blockaden versprechen. Doch kaum eines ist bisher so handlich und schnell einsetzbar wie die Fächer-Variante von Ingrid Scherübl und Katja Günther aus dem UTB-Verlag.

Fächern um jedes Wort?

Der Schreibimpulsfächer soll in jeder Phase des Schreibens helfen, besonders wenn der Schreibprozess stockt. Doch was soll ein „Schreibimpulsfächer“ eigentlich sein?
Etwas länger und schmaler als ein Brillenetui hat der Fächer eine kompakte und handliche Form. Er besteht aus losen Blättern, die mit einer Schraube fest aneinander geheftet sind. Das dicke, griffige Papier lässt sich gut durchblättern – konstruktiv gesehen erfüllt der Fächer schon mal seinen Zweck.
Auf den 55 Fächerseiten finden sich Tipps in Form von Fragen, Aufforderungen oder Gedankenspielen. Der Fächer hat sogar eine kleine Anleitung, die sich auf dem ersten Fächerblatt befindet. Er ist unterteilt nach Arbeitseinheiten, die den Schreibprozess bestimmen:

  • Einstimmen,
  • Loslassen,
  • Durchsteigen,
  • Dranbleiben und
  • Abrunden

Klingt nicht sehr spezifisch, aber trifft den Kern des Problems. Und die Erkenntnis, dass Schreiben aus verschiedenen Phasen besteht, empfinde ich als hilfreich für das strukturierte Arbeiten. Die Arbeitseinheiten sind zudem farblich voneinander abgehoben, sodass der Fächer bei einer Schreibblockade schnell eingesetzt werden kann. Für jede Arbeitseinheit gibt es pro Fächerblatt einen kurzen, griffigen Tipp, der meist aus einem einzigen Satz oder einer Frage besteht. Zum Beispiel für die Einheit „Einstimmen“: „Wie sieht eine wirklich erholsame Pause für dich aus? Was lässt du besser?“. Für die Phase des „Dranbleibens“ soll dieser Tipp helfen: „Wie kann Dein Betreuer Dich aktuell unterstützen? – Dein Erfolg ist auch sein Erfolg.“

So geht „Fächern“

Man muss sich bewusst sein, in welcher Arbeitsphase man gerade steckt. Nehmen wir mal die des „Durchsteigens“. Das ist laut Autoren die Phase des „Drin-Seins“, hier sind neue Perspektiven nützlich und dass man den Überblick nicht verliert. Man sucht sich den Teil des Fächers heraus, der Tipps für diese Phase gibt. Das ist etwas mühselig, wenn man die anderen Kategorien nicht mit durchblättern möchte. Der letzte Schritt ist, sich blind ein Fächerblatt der jeweiligen Phase herauszuziehen – wie bei einem Kartentrick – und den Tipp als Denkanstoß zu nutzen. Der gezogene Schreibimpuls könnte zum Beispiel lauten: „Das Thema Deiner Arbeit: Erkläre es so einfach wie möglich einem Viertklässler!“ So erhält man schnell eine überraschende Inspiration, die die Schreibblockade lösen kann.

Wohl dosierte Soforthilfe

Prinzipiell gibt es solche Tipps natürlich in Hülle und Fülle auch in anderen Ratgebern. Einige Vorschläge sind nicht neu und sicherlich nicht für jeden eine Hilfe: Zum Beispiel, dass die meisten an einem ordentlichen Arbeitsplatz besser arbeiten können. Dennoch: Ich fand einige Tipps neu und nützlich und bin froh, dass der Fächer auf meinem Tisch liegt und ich ihn beim Schreiben ab und zu durchblättern kann. Denn gerade die Kürze der Tipps und das praktische Fächer-Format bieten einen unerwarteten Denkanstoß, der beim Lesen eines langen Ratgeber-Textes schnell wieder verfliegen kann. Die Schreibimpulse helfen auf unkomplizierte Art eine neue Perspektive einzugehen und sich wieder auf seinen Text einzulassen.
Grundsätzlich bietet der Fächer keine dauerhafte Veränderung des eigenen Schreibprozesses. Er ist eher eine „Instant-Hilfe“, die mit genügend gutem Willen die akuten Beschwerden lösen kann, nicht aber die chronischen. Aber diesen Anspruch soll er laut Autoren ja auch nicht erfüllen. Wer nach langfristiger Hilfe sucht, muss doch zu den umfangreichen Ratgebern in Buchform greifen. Mein Fazit: Eine klasse Ergänzung, aber kein Ersatz für die Buch-Ratgeber.

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.

Literatur: Scherübl, Ingrid/Günther, Katja [2015]: Der Schreibimpulsfächer. Inspirationen für das Selbstcoaching beim Schreiben. Budrich: Opladen, Toronto. ISBN 978-3-8252-4344-9

Zurück bleiben Fragen – Rezension zu Haller „Das Interview“

Interviews - Auch für Technische Redakteure ein Thema

Interviews – Auch für Technische Redakteure ein Thema

Wenn Bücher erst einmal in der fünften Auflage vorliegen, dann muss man sich keine übertriebenen Sorgen um ihre Qualität machen. Michael Hallers „Das Interview“ ist so ein Buch: seit 1991 immer wieder aufgelegt, deckt alle Aspekte des Themas ab, ein Standardwerk halt. Weiterlesen

7 mal Themen finden leicht gemacht

(c) uschi dreiucker / pixelio.de

Finden statt suchen
(c) uschi dreiucker / pixelio.de

„Was soll ich nur schreiben?“ Normalerweise plagt uns Technische Redakteure dieses Problem ja eher nicht. Wenn wir ein Produkt dokumentieren, ist das Thema ja schon automatisch vorgegeben. Immer öfter sind Technische Redakteure aber auch verantwortlich für PR-nahe Aufgaben wie Fachartikel, Blogbeiträge oder Produktvorträge. Und da kann die Themensuche durchaus zum Problem werden. Hier also ein paar Tipps, die das Leben leichter machen.

1. Bereit sein

Themenideen warten nicht darauf, dass man gerade Zeit für sie hat. Sie kommen überraschend und meist genau dann, wenn man am wenigsten mit ihnen rechnet: unter der Dusche, nachts um drei, beim Bergsteigen… Da ist es gut, wenn man vorbereitet ist und Ideen zumindest skizzenhaft aufzeichnen kann. Wichtig ist nicht, dass man alles festhält. Es reichen die Weiterlesen

Günstiger Preis – aber schon ziemlich in die Jahre gekommen

Normensammlung für Übersetzer und technische Autoren

Normensammlung für Übersetzer und technische Autoren

Normen spielen für schreibende Berufe eine immer größere Rolle. Und wer – wie wir hier bei doctima – mit technischer Redaktion und standardisierter Briefkommunikation zu tun hat, der kommt um die Kenntnis von Normen nicht herum. Was in diesen Dokumenten niedergelegt ist an Stand der Technik, muss man einfach wissen und anwenden können. Einerseits um professionelle Arbeitsergebnisse zu erzielen, Weiterlesen

Auf zu neuen Themen…

Themen finden mit Barbara Hallmann

Themen finden mit Barbara Hallmann

Verglichen mit unseren Kollegen aus dem Journalismus haben wir als Technische Redakteure und Redakteurinnen es auf den ersten Blick recht einfach: Denn das Thema immer schon gegeben. Denn im Regelfall wissen wir genau, welches Produkt als nächstes zu dokumentieren ist.

Und doch gibt es immer wieder Fälle, bei denen wir eigenständig Themen entwickeln müssen: z. B. für Vorträge, Fachartikel, Blogbeiträge oder Pressemeldungen. In solchen Fällen kann die ungewohnte Themenfindung dann recht beschwerlich werden.

Was liegt also näher als von den Journalisten zu lernen, für die das ja Alltagsgeschäft ist? Bei meinen Recherchen bin ich auf das Buch von Barbara Hallmann „Themen finden „gestoßen.  Weiterlesen

Zielgerichtete Recherche für technische Dokumentationen

Christian Zehrer erforscht Rechercheprozesse in der Technischen Dokumentation

(c) Christiane Zehrer

Wir freuen uns über den heutigen Gastbeitrag von Dr. Christiane Zehrer. Sie hat in ihrer Promotion Rechercheprozesse in der Technischen Redaktion erforscht – ein Thema, das uns im doctima Blog schon lange umtreibt.

Christiane Zehrer beschäftigt sich als wissenschaftliche Mitarbeiterin an der Universität Hildesheim neben Wissenskommunikation und Multimodalität auch mit Leichter Sprache im Rahmen der gleichnamigen Forschungsstelle.

 

Aufgabe der technischen Redaktion ist es, Inhalte für eine bestimmte Zielgruppe korrekt darzubieten. Was bislang häufig übersehen wird: die Darbietung bzw. Aufbereitung der Inhalte ist bereits der zweite Schritt in einem gedachten Arbeitsprozess der technischen Redaktion. Denn bevor man Inhalte aufbereiten kann, muss man diese zunächst überhaupt zur Verfügung haben. Dies geschieht in der Phase der Weiterlesen

Agile Entwicklung

Titelseite Agile DokumentationDas Stichwort „Agile Entwicklung“ geisterte in den letzten Jahren verstärkt durch die IT-Branche. Dabei wird dieses Konzept schon seit den 1990er Jahren in der Wirtschaft angewandt.

Das Konzept zielt auf die optimale Nutzung der zur Verfügung stehenden Ressourcen ab. Durch die Einbindung des Kunden in den Prozess kann flexibel und schnell auf neue Anforderungen und Probleme reagiert werden. Dabei stehen die Teammitglieder und deren Arbeitsweise im Vordergrund. Viele dieser agilen Methoden sind deshalb auf direkte Kommunikation optimiert, um Entscheidungs- und Diskussionswege kurz zu halten.

Klingt gut? Ist es auch – zumindest auf dem Papier. In der Praxis stellen sich bei der Umsetzung jedoch Weiterlesen