Inhaltsverzeichnis
Lieferantendokumentation stellt Technische Redaktionen oft vor komplexe Herausforderungen, gilt es doch die Dokumentation der einzelnen Komponenten in die Gesamtdokumentation zu integrieren. Aber auch abseits dieses Themas bietet die neueste Ausgabe der tekom-Zeitschrift wieder ein Potpourri an spannenden Beiträgen, von denen wir uns einige genauer angeschaut haben.
Hier nun also unsere Kommentare zu ausgewählten Beiträgen aus der technischen kommunikation Ausgabe 04/2022 – viel Spaß beim Lesen!
Johannes Dreikorn
Senior Consultant
Wichtiger als gedacht
Manuel Schneider, technische kommunikation 04/2022, S. 11-14
Wenn Sie wenig Lesezeit haben, empfehle ich Ihnen die Prozess-Grafik auf Seite 14. Wer so ein Verfahren bei sich implementiert, hat rund um das wirklich sperrige und facettenreiche Thema Lieferantendokumentation schon viel richtig gemacht. Manuel Schneider empfiehlt als Steuerungsinstrument einen sog. „Hausstandard“ – also einen Leitfaden, der die zentralen Regeln, Anforderungen und Abläufe schriftlich fixiert.
Genau das machen wir auch mit unseren Kunden, wenn es um zentrale Arbeitsprozesse in der Redaktion geht. Ein Leitfaden ist ein geschicktes Instrument, um relevantes Wissen handlungsorientiert bereitzustellen. Für sich als Redaktion (interne Zielgruppe) und für die externen Zulieferer. Und als Zusatznutzen: Wer einen Leitfaden hat, kann nachweisen, dass er sauber und mit System arbeitet. Das ist gerade dann ein enormer Nutzen, wenn es tatsächlich einmal zu vertraglichen oder juristischen Auseinandersetzungen kommt.
Sarah Gründling
Computational Linguist & Developer
Erfolgsgarant Entwicklerportale
Dr. Michael Meng, technische kommunikation 04/2022, S. 28-34
Gute Dokumentation ist auch in der Entwicklung ein entscheidender Faktor. Vielleicht sogar noch mehr als in anderen Branchen. Eine gut dokumentierte, mittelmäßige API würde ich jederzeit einer sehr guten, aber lückenhaft festgehaltenen API mit nur wenigen Codebeispielen vorziehen. Es spart Zeit, Mühe und nicht zuletzt Geld, mit einer gründlichen, praktikablen Dokumentation arbeiten zu können.
Das Bild, das Dr. Meng über ein Entwicklerportal zeichnet, ist sehr umfassend und ausführlich. Häufig genug deckt ein Entwicklerportal aber nicht alle die von ihm genannten Punkte ab.
Als Entwicklerin liegt mein Augenmerk auf der Verständlichkeit der erklärenden Texte, der Codebeispiele und dem schnellen Auffinden von Informationen, die ich benötige, um eine Idee umzusetzen. Der Autor hat vollkommen recht damit, dass ein erfolgreiches Portal diese Kriterien in sich vereinen sollte. Doch in der Praxis dienen Foren der Community als Quelle für Antworten oder YouTube als Tutorial-Unterstützung, um loslegen zu können.
Wenn der Trend nun zu weiter ausgebauten Entwicklerportalen geht, dann ist aber bestimmt mehr als eine Branche froh darum!
Markus Nickl
CEO
Beschwerde als Mehrwert
Anne Lehrndorfer & Theresa Lehrndorfer, technische kommunikation 04/2022, S. 47-50
Ein angenehm zu lesender Beitrag, der auf kurzem Raum alle wesentlichen Punkt zum Beschwerdemanagement aufzeigt. Was nicht heißt, dass Technische Redakteur:innen nicht die eine oder andere neue Information entdecken werden, denn der Umgang mit Beschwerden scheint uns oft weit weg. Dabei kennen wir ja alle die Klagen über schlechte Gebrauchsanleitungen. Vielleicht ist es ja nicht so, dass sich niemand über unsere Anleitungen beschwert, sondern dass wir die Beschwerden nur nicht zu hören/lesen bekommen?
Auf der strategischen Ebene ist es deshalb sicher sinnvoll, als Redaktion auch einmal das Thema Kundenzufriedenheit in den Blick zu nehmen. Wir sollten genauer überlegen, wie Beschwerden unsere Redaktionen erreichen können. Denn wie Lehrndorfer und Lehrndorfer so richtig schreiben: Beschwerden sind „ein wertvoller, persönlicher Kundenkontakt (Customer Touchpoint)“.
Haben Sie die neueste Ausgabe der tekom-Zeitschrift schon gelesen? Wir freuen uns auf den Meinungsaustausch mit Ihnen!
Coverfoto Zeitschrift: © tcworld GmbH
