Wie technische Redakteure den Wandel in der technischen Kommunikation aktiv mitgestalten können

Wenn der Zeitdruck steigt, bleibt die Qualität leicht auf der Strecke.

Wenn der Zeitdruck steigt, bleibt die Qualität leicht auf der Strecke.

In unserer Reihe zu Trends in der Technischen Redaktion haben wir heute Ina Franke zu Gast. Sie ist Senior Marketing Manager bei der Acrolinx GmbH. Acrolinx hilft Unternehmen überzeugenden Content zu erstellen: markenkonform, wirkungsvoll und skalierbar. Ausgestattet mit einer fortschrittlichen Sprachtechnologie, „liest“ Acrolinx Content und leitet Autoren an, ihn zu verbessern. Mehr Informationen dazu finden sich auf acrolinx.de.

Der Wert der technischen Kommunikation wird auf Unternehmensebene häufig unterschätzt. Manager betrachten die technische Kommunikation oft als notwendige Kostenstelle und übersehen dabei ihre enorme Bedeutung für die Gewinnung und Bindung von Kunden. Gleichzeitig tun technische Redakteure noch immer wenig, um diese Vorstellung zu korrigieren. Besonders, wenn sie ihren Aufgabenbereich darauf reduzieren, Verbrauchern Fragen zu Produkten und Fehlerbehebungen zu beantworten.

Mit der weiterhin steigenden Bedeutung von Content beobachten wir 6 wichtige Veränderungen im Bereich der technischen Kommunikation, die die Rolle von technischen Redakteuren neu definieren:

  1. Die Erstellung von technischem Content wird vorverlagert. Immer häufiger sind es Ingenieure und Mitarbeiter in der Produktentwicklung und im technischen Support, die Inhalte erstellen. Dadurch wird es schwieriger, für Konsistenz zu sorgen – sowohl innerhalb der technischen Redaktion als auch unternehmensweit. Verschärft wird das Problem dadurch, dass Content oft ohne eine abteilungsübergreifende Abstimmung veröffentlicht wird. Dies kann zu inkorrekten Informationen und unzufriedenen Kunden führen.
  2. Knappe Budgets oder eine fehlende Wertschätzung der technischen Kommunikation können zur Folge haben, dass das Erstellen von technischem Content ausgelagert wird. Auch dies führt dazu, dass Inhalte von zentralen technischen Ressourcen wie Produktentwicklungsteams oder der gesamten Content-Strategie abgekoppelt werden.
  3. Content wird zunehmend von Nicht-Muttersprachlern erstellt. Zu den Folgen dieser Entwicklung zählen fehleranfälliger und inkonsistenter Content, schwer verständliche und kostenaufwändige Übersetzungen und ein mangelnder redaktioneller Überblick. Das Fehlen effektiver Qualitätskontrollen erschwert es außerdem, Fehler zu beheben – oft bleiben diese unkorrigiert.
  4. Vor allem englischer Content wird zunehmend von Nicht-Muttersprachlern gelesen. Vor diesem Hintergrund müssen technische Informationen leicht verständlich sein und interkulturellen Anforderungen genügen. Eine computerunterstützte Übersetzung kann für die Lokalisierung von technischem Content hilfreich sein, erfordert aber eine zusätzliche Qualitätskontrolle.
  5. Engere Zeitpläne machen schnellere Turnarounds erforderlich. Dabei ist es wichtig, dass technische Redakteure frühzeitig integriert werden. Das ist leider nicht immer der Fall. Der Fokus auf Kosten und Schnelligkeit führt häufig sogar dazu, dass technische Inhalte erst auf Nachfrage von Kunden geschrieben werden. So hinkt technischer Content den Entwicklungen oft hinterher.
  6. Technische Redakteure teilen ihr Wissen in sozialen Medien, die von immer mehr Kunden als Ergänzung oder sogar als Ersatz für die eigentliche Dokumentation wahrgenommen werden. Statt Content vor der Auslieferung eines Produkts zu erstellen, reagieren technische Redakteure in Echtzeit auf Fragen von Kunden. Hierbei ist es wichtig, eine gute Balance zu finden. Ansonsten besteht die Gefahr, dass Unternehmen Social Media als zusätzliche Rechtfertigung dafür sehen, technischen Content weiter zu kürzen.

Als technischer Redakteur sollten Sie die genannten Entwicklungen zum Anlass nehmen, sich geschickt neu zu positionieren. Dazu sollten Sie zunächst Ihre Selbstwahrnehmung überprüfen und sich den Wert ihrer Arbeit bewusstmachen.

Die technische Kommunikation kann einen wertvollen Beitrag dazu leisten, die Umsätze Ihres Unternehmens zu steigern. Überlegen Sie, wie Sie strategische Prioritäten Ihres Unternehmens unterstützen und dies nachvollziehbar demonstrieren können. Zeigen Sie, dass die Nachfrage nach Ihrem Content wächst. Dabei können Sie sich auch auf die Marketing-Strategie Ihres Unternehmens und die Wünsche von Kunden beziehen.

Ihre Arbeit spielt eine wichtige Rolle, das Leistungsversprechen Ihres Unternehmens umzusetzen. Um das Potential Ihrer Rolle voll auszuschöpfen, müssen Sie den Wert Ihrer Arbeit jedoch überzeugend auf den Punkt bringen.

Gehörige Horizonterweiterung – Wie Bürger- und Kundenkommunikation gelingen kann

Die Qualität eines Textes kann nicht losgelöst von der kommunikativen Funktion bestimmt werden. Während ich in diesen Wochen ein kommunales Serviceunternehmen dabei unterstütze, seine Kundenanschreiben hinsichtlich Verständlichkeit, Prägnanz und Leserbezug einer Generalüberholung zu unterziehen, liegt das „Handbuch Bürgerkommunikation“ griffbereit neben mir auf dem Schreibtisch. Aus ihm stammt der eingangs zitierte Satz. Ihn kann ich aus meiner Erfahrung in der Beratung von Kommunen, Banken, Krankenkassen und Versicherungen nur unterschreiben. Und er spielt auch in meinem aktuellen Projekt eine Rolle.

Wesentlich mehr als ein Ratgeber

Das Handbuch Bürgerkommunikation: Es fasst die Erfahrungen und fachlichen Grundlagen eines großangelegten Projekts der Stadt Arnsberg zusammen, die schon vor über zehn Jahren zusammen mit einem linguistisch kompetenten Beratungsteam daran ging, ihren Sprach- und Schreibstil systematisch auf größtmögliche Bürgernähe hin auszurichten. Und das mit Erfolg. Das Handbuch Bürgerkommunikation ist damit ein gutes Beispiel dafür, wie sprachwissenschaftlich fundierte Kommunikationskonzepte einen entscheidenden Unterschied machen.

Dieses Attribut „wissenschaftlich“ ist es auch, das für mich den großen Mehrwert dieses Buches gegenüber anderer Literatur im Bereich Textoptimierung ausmacht – vor allem gegenüber der klassischen Ratgeberliteratur. Es geht nicht um ein bisschen mehr „Pfiff“ oder einen „lockeren Stil“ – sondern alles, was gefordert und geraten wird (und das passiert durchaus mit ganz konkreten Beispielen und Empfehlungen), steht auf soliden fachlichen Füßen. Und so bilden die Basis dieses Buches und seiner insgesamt neun Module (Kapitel) auch nicht die erwartbaren Stilblüten und Schenkelklopfer aus dem Fundus deutscher Behördenpublikationen, sondern Themen wie „Modelle der Textverständlichkeit“ (Modul 1), „Soziale Klugheit“ (Modul 3) oder „Instrumente der Identitätskommunikation“ (Modul 7).

Sparringspartner für harte Nüsse

Das zeigt schon: Ganz einfache Kost ist dieses Buch nicht. Es geht um Sprachwissenschaftliches, Kommunikationswissenschaftliches, Soziologisches und auch (Staats-)Philosophisches. Und es gibt Nebentöne, die in der mitunter stark auf Effizienz getrimmten Debatte um die Optimierung von Kommunikation eher ungewöhnlich sind, z. B. wenn es um die gesellschaftliche Verantwortung von Kommunizierenden geht.

Mein Fazit: Wer mehr als bloß ein paar Tipps zur Bürger- und Kundenkommunikation sucht, wer als Profi einen weiten Horizont benötigt und tiefer verstehen möchte, weil er nur so zu wirklich passenden Lösungen findet: Dem kann ich dieses Buch nur empfehlen.

Ich werde es auf jeden Fall noch einmal intensiv durcharbeiten. Und es dabei auch befragen zu Innovationsthemen, die in unseren Projekten zunehmend wichtig werden. Zum Beispiel wie sich das Konzept der Leichten Sprache noch wirkungsvoller in die Bürger- und Kundenkommunikation integrieren lässt.

Literatur: Ebert, Helmut/Fisiak, Iryna [2016]: Handbuch Bürgerkommunikation: Moderne Schreib- und Kommunikationskultur in der Dienstleistungsverwaltung. LIT Verlag, Berlin, 331 Seiten. 978-3825887575

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.

Erzähl mir keine Geschichten

Welche Geschichte wohl hinter diesem Schild steckt?

Heute auf meiner Leseliste: „Digital Storytelling“ von Dieter Georg Herbst und Thomas Heinrich Musiolik. Storytelling? Ja, Geschichten haben wieder Konjunktur im Marketing und der Unternehmenskommunikation. Da lohnt es sich sicher, einmal einen Blick über den Tellerrand zu wagen und zu gucken, ob das nicht auch für die Technische Redaktion ein interessanter Trend werden könnte. Und da kann die Beschränkung auf „digital“ eigentlich nur nutzen, schließlich sind auch bei uns die meisten Texte digital.

Mit einigermaßen großen Hoffnungen habe ich mich also an die Lektüre gemacht. Ich hoffte zum einen mehr darüber zu erfahren, wie Geschichten funktionieren, wie man sie in einem Unternehmenskontext nutzbar macht. Und zum anderen hat mich interessiert, was digitale Geschichten von den Geschichten unterscheidet, die wir alle kennen.

Und ich muss sagen, ich wurde auf ganzer Linie enttäuscht. Was eine Geschichte ist, das setzen die Autoren anscheinend als gegeben voraus. Jedenfalls weiß ich das am Ende des zweiten Kapitels immer noch nicht; das dritte Kapitel zeigt mir aber schon wie ich zum „eigenen Digital Storytelling“ komme. In der Zwischenzeit habe ich bereits mehrfach gehört, wie wichtig es ist, die Lagerfeueratmosphäre des Geschichtenerzählens für Unternehmen nutzbar zu machen. Dabei wird immer wieder mit unterschiedlichsten Begriffen jongliert, die alle irgendwie mit „Geschichten“ zu tun haben: Bilder, Emotionen, Transparenz – alles ist irgendwie eine Story und auch wieder nicht.

Vielleicht liegt das ja auch daran, dass Herbst und Musiolik selbst erstaunlich wenig Geschichten erzählen. Stattdessen changiert der Text zwischen Marketing-Speak und Quasi-Wissenschaftlichkeit. Beispiele werden zwar immer wieder genannt, aber nur angerissen und nicht besprochen, sondern irgendwie immer schon als bekannt vorausgesetzt. Da fehlt es mir letzten Endes an Konkretheit.

Zum Schluss noch ein Geständnis: Es passiert mir nur ganz selten, aber dieses Buch habe ich nicht zu Ende gelesen: Es kann also sein, dass „Digital Storytelling“ so ab dem zweiten Drittel eine komplette Kehrtwende macht und all das liefert, was ich mir erhofft habe. Vielleicht ein Fehler, aber mir fehlte schlicht und einfach die Geduld. An dem Thema Storytelling (und Technische Dokumentation) werde ich sicher dran bleiben. Mit „Digital Storytelling“ aber nicht.

Literatur: Herbst, Dieter Georg; Thomas Heinrich Musiolik [2016]: „Digital Storytelling. Spannende Geschichten für interne Kommunikation, Werbung und PR“. UVK Verlagsgesellschaft mbH, Konstanz und München. ISBN 978-3-7398-0017-2

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.

Futter für Berater, Trainer und Leute in Führungsverantwortung

Ein Büchlein von Eva Buff Keller und Stefan Jörissen über Abschlussarbeiten liegt schon eine ganze Weile auf meinem Schreibtisch. „Du betreust doch bei uns die meisten Masterarbeiten“ – so kam es dorthin. In die Hand genommen habe ich es immer wieder über die letzten Monate. Und heute möchte ich meine Leseeindrücke endlich teilen.

Weil wir Abschlussarbeiten betreuen

Ja, es ist so. Hier bei doctima entstehen jedes Jahr zwei bis drei Abschlussarbeiten. Meist sind es linguistische oder redaktionelle Themenstellungen. Einfach deswegen, weil wir als Dienstleistungs- und Beratungsunternehmen am Puls der Zeit bleiben und neue Ideen fachlich austesten wollen.

So stehen in unserer Bibliothek mittlerweile eine ganze Reihe Abschlussarbeiten von Studentinnen und Studenten, die im Rahmen eines Praktikums bei uns engagiert waren und als „Krönung“ dieser Zeit zu einem praxisrelevanten Thema geforscht und geschrieben haben. Darunter Arbeiten zu „Checklisten als Instrumente in der Qualitätssicherung“, zum Konzept der „Leichten Sprache“ oder – in Kürze – zu Redaktionsleitfäden für Redaktionen, die ein CMS einsetzen.

Selektives Lesen schärft das Handwerkszeug

Anfangs war ich – ehrlich gesagt – ein bisschen skeptisch, ob ich in meiner Arbeit von diesem Buch profitieren würde. Denn es richtet sich erst einmal an die akademische Welt. Also Leute, die in ihrer Funktion als Dozenten an Hochschulen Abschlussarbeiten von A bis Z betreuen. Eine Hochschule tickt doch sehr anders als ein Unternehmen. Außerdem gibt es Themen, die ich als Zweitbetreuer getrost dem Erstkorrektor und Hauptbetreuer überlassen kann wie zum Beispiel die Frage, ob die Inhalte durchgängig den Anforderungen wissenschaftlichen Schreibens genügen.

Diese Skepsis habe ich nach und nach abgelegt. Und zwar aus mehreren Gründen. Zum einem tritt das Buch mit einem sehr weiten thematischen Horizont an. Wenn es zum Beispiel in Kapitel 2 um die Vermittlung fachlicher und überfachlicher Kompetenzen geht, lesen in mir vor allem der Trainer, Coach und Abteilungsleiter mit großem Interesse mit. Oder wenn Kapitel 4 das „Kontinuum zwischen Führen und Beraten“ reflektiert, finde ich Kompetenzen thematisiert, die ich im Projekt- und Beratungsgeschäft tagtäglich brauche.

Das alles ordne ich – Sie merken es – für mich erst einmal gar nicht in die Rubrik „Abschlussarbeiten“ ein, sondern verknüpfe es mit dem Handwerkszeug, das ich für meinen eigenen Beruf benötige. Diese fachliche Fundiertheit, die mir diese zugegeben sehr selektive Nutzung ermöglicht, halte ich für eine der ganz großen Stärken des Buchs. Man liest und lernt viel zum Thema Wissensvermittlung, Begleitung von Menschen und Bewertung von Inhalten – egal aus welcher Disziplin man kommt.

Fachlich fundiert, systematisch aufbereitet

Natürlich muss man mit dem diskursiven Ansatz des Buchs zurechtkommen. Viele Themen werden nur kurz angesprochen, für Details müsste man den zahlreichen Literaturverweisen auf einschlägige Fachliteratur nachgehen. Das Gute daran: Es wird kein verkürztes und billiges Rezeptwissen feilgeboten. Man bewegt sich auf fachlich solidem Grund.

Und trotzdem wird man nicht mit einer Menge akademischer Richtigkeiten alleine gelassen. Dadurch, dass alle Inhalte in ein generisches Modell eingebunden sind und es viele praktische Tipps und griffige Aufbereitungen zum Beispiel in Form von Diagrammen gibt, lässt sich viel direkter Profit schlagen.

Wo ich mir ganz sicher bin: Wenn die nächste Abschlussarbeit zur Betreuung ansteht, werde ich mich durch das Büchlein weiter coachen lassen. Und dann wirklich ganz im Sinne von Autorin und Autor.

Literatur: Eva Buff Keller, Stefan Jörissen [2015]: „Abschlussarbeiten im Studium anleiten, betreuen und bewerten“. UTB. ISBN 978-3825243456

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.

Von A nach B – 6 Tipps zur Contentmigration

Pelikane im Flug

Nur selten ist Migration so einfach wie bei Zugvögeln…

Wenn es um die Bestandsdatenübernahme geht, kann man beim Wechsel des CMS einige böse Überraschungen erleben. Denn bei der Übernahme von Altdaten steckt der Teufel im Detail. Deshalb wollen wir heute einmal ein paar Tipps zu den Details geben, auf die Sie in Ihrem Contentmigrations-Projekt achten sollten.

Zeichenkodierung beachten

Welche Zeichenkodierung haben eigentlich die Ausgangsdaten: ISO-8859-1, Windows-1252, Unicode oder etwas noch Exotischeres? Und welche Zeichenkodierung erlaubt bzw. verlangt das Zielsystem. Gibt es im Ausgangstext ein durchgehendes Escaping (Kodierung von Sonderzeichen durch Zeichenfolgen, z. B. „äußerst“ wird zu „äußerst“) und wie lässt sich dieses in das Zielsystem transformieren? Wer hier die Daten vorab genau analysiert, kann eine Menge Probleme im Migrationsprozess vermeiden.

Inkompatible Layout- und Textkonstrukte

Sind die Textkonstrukte zwischen Ausgangs- und Zielsystem kompatibel zueinander.  Komplexe semantische Handlungsanweisungen, tief geschachtelte Listen oder Zeichenformatkombinationen sind typische Problemstellen. Manches System lässt schon die Kombination aus Fett- und Kursivmarkierung (<b><i>Si meliora…</i></b>) aus der Kurve fliegen.

Makros machen Ärger

Gelegentlich werden auch statische Dokumente teilweise dynamisch gestaltet (z. B. durch eingebundene Excel-Berechnungen) oder nachträglich verändert (z. B. durch Word-Makros). Im eigentlichen Bestandscontent sind solche Mechanismen oft nicht leicht zu erkennen und manchmal sind sie den Benutzern nicht einmal bewusst. Hier ist also Recherche angesagt und ein Vergleich zwischen dem Bestandscontent und den ausgelieferten Dokumenten. Hat man solche Mechanismen entdeckt, gilt es zu entscheiden, ob sich auf sie verzichten lässt, ob sie im Zielsystem nachimplementiert werden können oder ob sie durch geeignete Mechanismen des Zielsystems ersetzt werden müssen.

Grafikformate

Auch bei Grafiken gibt es Formatprobleme – und nicht nur wenn es um print oder online als Ausgabemedien geht. Immer wieder kommen bestimmte Zielsysteme nicht mit den Formaten des Ausgangssystems zurecht. Word kann zum Beispiel nicht mit SVG umgehen. Umgekehrt stellen Word-Zeichnungen für fast alle anderen Systeme ein Problem dar. Also: Auch hier genau prüfen, was möglich ist und im Problemfall zum Beispiel ein Kompromissformat finden, mit dem beide Systeme zurechtkommen.

Beschriftungen

Neben den eigentlichen Grafikformaten sollten Sie sich auch die Art der Beschriftung in den Grafiken ansehen. Hier sind ganz unterschiedliche Varianten üblich: fest im Bild integriert (eher selten), als gruppierte Objekte (häufig und schwierig zu migrieren), mit einer eigenständigen, unabhängigen Legende (aufpassen, damit die Zusammenhänge nicht verloren gehen) u. v. m. Bedenken Sie auch die Optionen, die das Zielsystem bietet. Vielleicht ist ja z. B. eine Clickmap die bessere Lösung für die Beschriftung. Denn wenn man schon den Aufwand für die Migration betreibt, dann sollte der Content im Zielsystem auch besser sein als zuvor.

Ein Raum für Informationen

Uwe Reißenweber (c) DOCUFY

Im ersten Teil unserer Reihe zu Trends in der Technischen Dokumentation begrüßen wir Uwe Reißenweber. Er ist Geschäftsführer der DOCUFY GmbH und gilt als Experte für die Implementierung, Einführung und Weiterentwicklung von Technischen Redaktionssystemen. 2016 begründete er die Strategie der Multi-Level-Dokumentation und ebnet so den Weg für die Zukunft der Technischen Dokumentation in einer digitalen Welt.

Aktuelle Trends wie Digitalisierung, Industrie 4.0, Mobile Computing, Social Selling Big Data und Co. beeinflussen die Produkte von morgen und prägen letztlich die zukünftige Entwicklung unserer gesamten Gesellschaft.

Die Technische Dokumentation bleibt davon natürlich nicht verschont. Im Gegenteil, Informationen entwickeln sich immer mehr zum Schmierstoff unserer digitalen Welt und wer könnte diese besser liefern als die Technische Dokumentation? Für sie besteht also die einmalige Chance, das traditionelle Mauerblümchendasein zu verlassen und zu einem der Big Player im Unternehmensgefüge aufzusteigen.

Die Dokumentation von morgen

Damit dies möglich wird, muss sich die Technische Dokumentation ganz neu erfinden: Der Informationsnutzer von morgen wird erwarten, dass ihm die richtige Information im Kontext seiner aktuellen Nutzung durch intelligente Informationssysteme quasi automatisch wie auf dem Silbertablett serviert wird. Selbstverständlich müssen die Informationen dabei mehrdimensional miteinander verknüpft sein. So möchte man in einem Produktkonfigurator von der Nutzerbeschreibung einer bestimmten Produktoption mal schnell in die zugehörige Bedienungsinformation wechseln, den Entsorgungshinweis einsehen oder sinnvolles Zubehör sichten, bevor es dann an die tatsächliche Kaufentscheidung geht. Im Servicefall soll am besten zeitgleich mit dem Serviceauftrag, die notwendige Dokumentation der anstehenden Serviceprozeduren mitgeliefert werden, idealerweise in der richtigen Reihenfolge. Und natürlich wären Tipps und Tricks der Kollegen sehr praktisch, wenn diese sich bereits zu einer bestimmten Tätigkeit oder Fragestellung geäußert haben. Notfalls wäre man sicher auch selbst bereit, eigene Tipps und Kommentare hinzuzufügen – zum Beispiel, wenn es eine besonders gute Lösung für ein Problem gibt.

Im privaten Alltag sind all diese genannten Dinge mit facebook, Google, Amazon und Co. schon gelebte Realität. Nur im professionellen Arbeitsumfeld ist das vorherrschende Informationssystem heute leider noch oft die PDF-Datei.

Das Dokument hat ausgedient

Um aber den zukünftigen Dokumentationsanforderungen gerecht zu werden, ist eine Abkehr von unserem liebgewonnenen Dokument unausweichlich. Einerseits fordern die Informationsnutzer den direkten Zugriff auf passende und korrekte Einzelinformationen. Andererseits wird der dokumentorientierte Redaktionsprozess zunehmend mühsamer, da die zu dokumentierenden Produkte immer varianten- und umfangreicher werden. So führt die Strategie des Maximaldokuments, das alle Varianten und Optionen einer ganzen Produktreihe umfasst, immer öfter ins unbeherrschbare Chaos. In Zeiten, in denen konkrete Produkte sich immer mehr auflösen und zu einer Funktionswolke mutieren, aus der jeder Nutzer sein persönliches Produkt individuell zusammenstellen kann, ist ein dokumentorientierter Redaktionsprozess gänzlich undenkbar. Warum? Mit dem Verschwinden konkreter Produkte entfällt eben auch die Grundlage für einen dokumentorientierten Redaktionsprozess.

Der Informationsraum

Arbeiten im Informationsraum (Symbolbild) (c) DOCUFY

Aber wie sieht die Lösung der zukünftigen Dokumentationsanforderungen aus? Wer übernimmt die Strukturierung, Bündelung und Zuordnung der Information, wenn es kein Dokument mehr gibt? Aus konzeptioneller Sicht ist die Antwort ganz einfach. Wir brauchen einen Informationsraum. Doch wie muss man sich so einen Informationsraum vorstellen? Welche Aufgaben übernimmt er und welche Funktionen hat er?

Der Informationsraum liefert eindeutige Adressen für alle relevanten Informationen eines Geschäftes. Die Einsatzmöglichkeiten gehen dabei weit über die klassische Technische Dokumentation hinaus. Vielmehr können dort Informationen zum gesamten Produktlebenszyklus, von der Entwicklung über Marketing und Vertrieb, Installation, Betrieb, Wartung und schließlich Entsorgung verankert werden. Dabei ist der Informationsraum nicht als eigenständiges Softwaresystem zu verstehen, sondern vielmehr als Konzept, das die eindeutige Adressierung oder besser Klassifizierung von Einzelinformationen ermöglicht.

Auf Basis dieses Informationsraums kann dann zukünftig der Informationsbedarf geplant, die redaktionelle Erstellung gesteuert und die zielgerichtete Nutzung der Information in den verschiedensten Informationssystemen ermöglicht werden.

Zugegeben, das hört sich ziemlich abenteuerlich an und wird die gewohnte Arbeitsweise der traditionellen Technischen Redaktion auf den Kopf stellen. Und es klingt nach viel Arbeit, so einen Informationsraum initial zu erstellen und dauerhaft zu pflegen. Aber um auch zukünftig erfolgreich sein zu können, ist es für Unternehmen unerlässlich, alle geschäftsrelevanten Informationen zu konsolidieren und für verschiedenste Zwecke verfügbar zu machen. Und dies ist die ureigenste Qualifikation und Aufgabe der Technischen Dokumentation.

Ich wünsche Ihnen viel Spaß beim Aufbau Ihres Informationsraums. Und keiner hat behauptet, der Weg zum Big Player wäre leicht… 🙂

Für mehr Information:
www.multi-level-dokumentation.de
www.docufy.de

 

Technischer Content – auf dem Weg in die Zukunft

Achtung CatContent: Was die Zukunft wohl bringt?

Vor einigen Jahren noch hatte ich das Gefühl, dass sich in der Technischen Dokumentation Innovationsstillstand breit macht. Dieser Eindruck hat sich Gott sei Dank in den letzten Jahren geändert. Heute erleben wir eine Branche, die sich (wieder) neu erfindet. Einige Stichworte: mobile Dokumentation, internationale Teams und Redaktionsprozesse, Digitalisierung, Industrie 4.0 und neue Techniken wie VR-Interfaces, 3D-Druck.

Aufgefallen ist mir aber auch eine größere Offenheit gegenüber den Veränderungen. Nachdem sich Technische Redakteure über lange Jahre von den Kollegen aus den Marketing-Abteilungen abgegrenzt haben, sehe ich heute wieder eine größere Offenheit und Bereitschaft von den „anderen“ zu lernen, ohne dabei die eigenen Kernthemen und -standpunkte aufzugeben. Das mag mit einer jungen, gut ausgebildeten Schar von Technikredakteuren zu tun haben, die sich oft als Medienspezialisten und nicht als schreibende Ingenieure verstehen. Begrüßenswert ist es allemal.

Wie wird es nun weitergehen mit der Technischen Dokumentation? Wir haben dazu Hersteller von Software-Systemen aus der Dokumentationsbranche gefragt: „Was sind in den nächsten fünf bis zehn Jahren die großen Trends in der Technischen Dokumentation? Wie wird sich das Arbeiten verändern? Wird es Dokumentation im heutigen Sinn überhaupt noch geben?“ Und spannende Antworten bekommen. Die Beiträge zu dieser Reihe „Trends in der Technischen Dokumentation“ werden in loser Folge erscheinen. Den Anfang macht an diesem Donnerstag Uwe Reißenweber von DOCUFY mit einem Post über „Informationsräume“.

Posts zu dieser Themenreihe

API-Dokumentation – Was brauchen und wollen Entwickler?

Code ist undokumentiert schwer zugänglich
(c) Markus Vogelbacher via pixelio.de

Heute freuen wir uns, wieder einmal eine Gastautorin im doctima-Blog zu begrüßen. Stephanie Steinhardt ist Dipl. Technik-Redakteur (FH) und wissenschaftliche Mitarbeiterin an der Hochschule Merseburg. Als freiberufliche Technik-Redakteurin betreut sie außerdem verschiedene Kunden z. B. aus dem Automobilbereich. In ihrem Post zeigt Sie uns erste Ergebnisse aus einer gemeinsamen Forschungsarbeit mit Prof. Dr. Michael Meng und Andreas Schubert (MA) an der HS Merseburg. Doctima ist an diesem Projekt als Vernetzungspartner beteiligt.

Die Sicht von Entwicklern auf API- Dokumentation ist oftmals sehr verschieden. Während die einen davon überzeugt sind, dass guter Code keiner Dokumentation bedarf, schreiben die anderen selbst gern Dokumentation und konsultieren sie auch häufig. Die Meinungen darüber, wie sie denn aussehen soll, die perfekte API-Dokumentation, gehen ebenfalls auseinander. Es existieren unterschiedliche Ansätze zu Aussehen, Darreichung und Inhalt einer solchen.

An der Hochschule Merseburg widmet sich seit zwei Jahren ein kleines Team von Technik-Redakteuren in einem Forschungsprojekt der Optimierung von API-Dokumentation. Die Fragen nach Struktur und Inhalt der perfekten API-Dokumentation sowie nach dem Leseverhalten der Entwickler stehen dabei im Mittelpunkt der Untersuchungen. Auf Basis von 23 durchgeführten Interviews, der Erhebung von Daten aus rund 100 Fragebögen und einer Beobachtungsreihe, bei der genau verfolgt wurde, wie Entwickler Programmieraufgaben lösen, sowie unter Berücksichtigung der bereits existierenden Studien im Umfeld von Entwicklerdokumentation können wir Empfehlungen geben, die API-Dokumentationen deutlich besser und effizienter nutzbar machen.

Nicht jeder Entwickler ist wie der andere.

Entwickler unterscheiden sich nicht nur in ihrer Einstellung zur Dokumentation, in den Jahren ihrer Programmiererfahrung oder bezüglich der Systemwelt, in welcher sie zu Hause sind. Sie unterscheiden sich vor allem in ihrer Arbeitsweise. So konnten wir in unseren erhobenen Daten zwei verschiedene Ansätze identifizieren, welche vor allem bei der Einarbeitung in eine neue API deutlich hervortreten. So gibt es Entwickler, die einen eher codegetriebenen Ansatz verfolgen und nach eigener Aussage gern direkt mit einem Code-Beispiel einsteigen. Sie erarbeiten sich den Umfang einer API eher intuitiv von unten nach oben. Es gibt aber auch Entwickler, die konzeptorientiert arbeiten und sich vor der Nutzung einer neuen API zunächst einen Überblick verschaffen. Entwickler, die der Meinung sind, dass es nützlich ist, das Konzept der API in Gänze zu verstehen, auch wenn nur ein Teil der API tatsächlich zur Problemlösung genutzt wird.

Abb.: 1 – Absolute Zeitwerte: Recherchezeit (farbig) vs. Bearbeitungszeit (grau) der Probanden 01-11

Besonders deutlich traten diese Verhaltensmuster in der von uns durchgeführten Beobachtungsreihe hervor. So haben 6 der 11 beobachteten Probanden im Konzeptbereich der API-Dokumentation unserer Test-API gelesen, wohingegen die anderen 5 kaum einen Blick hinein warfen und vorrangig auf Beispielcode fixiert waren.

Lesen ist nicht gleich lesen.

Trotz der gegensätzlichen Sichtweisen der Entwickler auf API-Dokumentation hat die Beobachtung gezeigt, dass im Beobachtungszeitraum von jeweils einer Stunde alle Probanden nahezu die Hälfte der Zeit mit der Recherche in der API-Dokumentation zubrachten, während die andere Hälfte für die tatsächliche Programmierung zur Lösung der Aufgaben verwendet wurde.

Wie die Analyse der entstandenen Eyetracking-Aufnahmen zeigte, scannten und überflogen die Entwickler die einzelnen Inhalte mehr, als dass sie tatsächlich Zeile für Zeile lasen. Dabei fokussierten Sie vorrangig auf die visuell hervorgehobenen Elemente, wie Hyperlinks, die Navigation und Beispielcode. Der erklärende Fließtext wurde meist nur dann gelesen, wenn aus dem Beispielcode allein keine Lösung abzuleiten war.

Das Leseverhalten schien darüber hinaus nicht nur beeinflusst von der individuellen Arbeitsweise, sondern war auch geprägt von der Einschätzung zum Schwierigkeitsgrad der gestellten Aufgabe. Bei Aufgaben, die schwieriger zu lösen schienen, waren die Probanden eher geneigt zu lesen, als bei Aufgaben, die einfacher wirkten.

Wer die Prozesse kennt, ist klar im Vorteil.

Bereits in den Interviews und in existierenden Studien kam zum Vorschein, dass mitunter alleinige Programmiererfahrung kein Garant ist für die schnelle Einarbeitung in eine neue API. Vielmehr entscheidend ist das vorhandene Domainwissen. Wer mit den zugrunde liegenden Prozessen vertraut ist, welche die API abbildet und dazu das Fachvokabular kennt, ist deutlich schneller bei der Einarbeitung und Lösung von Programmieraufgaben. Das zeigte auch unsere Beobachtungsreihe sehr eindrücklich (vgl. Abbildung 1 – Probanden 03, 04, 05,06 und 10 besaßen Domainwissen).

Demnach kommt der Vermittlung von Domainwissen in einer API-Dokumentation eine wichtige Rolle zu. Die Platzierung dieser Informationen ist mit Hinblick auf Leseverhalten und Arbeitsweise der Entwickler elementar.

Abb.: 2 – Beispiellayout für Codekommentare im Beispielcode (adaptierter Inhalt, basierend auf https://developers.shipcloud.io/reference/)

Der beste Ort für wichtige Informationen in einer API-Dokumentation ist einer, den alle Entwickler tatsächlich anschauen. Auf Basis der Interviews, den Fragebögen und der Beobachtung können nur Codebeispiele dieser Anforderung genügen. Sie werden von allen Entwicklern angesehen und als Basis der eigenen Programmierung verwendet. „Verkleidet“ man wichtige Informationen als Codekommentar und setzt diese deutlich vom restlichen Codebeispiel ab, kann man sicher sein, dass sie gesehen und, wenn kurz, auch gelesen werden. Auf ausführlichere Beschreibungen sollte zugunsten der eher konzeptorientierten Entwickler aber dennoch nicht verzichtet werden.

Dieser konkrete Optimierungsvorschlag und die zuvor genannten Erkenntnisse sind natürlich nur ein kleiner Teil der bisher gewonnenen Forschungsergebnisse. Unsere Untersuchungen dauern im Moment noch an. Daher sind wir auch sehr interessiert an Unternehmen, die bereit sind, sich an ähnlichen Studien zu beteiligen und damit die Zahl der möglichen Probanden vergrößern.

Kontakt: stephanie.steinhardt@hs-merseburg.de

Verständlichkeit – wissenschaftlich und praktisch

„verständlich kommunizieren“ an der Hochschule Luzern

Verständlichkeit ist bei uns ja eines der Kernthemen. Dass sich dazu auf wissenschaftlicher Seite leider weniger tut, als wir uns wünschen, habe ich im doctima Blog schon beklagt. Umso mehr hat mich gefreut, dass mich Sascha Demarmels vor kurzem auf ihr Blog an der Hochschule Luzern aufmerksam gemacht hat. Unter dem Titel verständlich kommunizieren bloggt ihre Arbeitsgruppe zu verschiedenen Themen rund um die Verständlichkeit – aus wissenschaftlicher Sicht wie auch in der praktischen Anwendung.

Leider sind die meisten Posts schon ein wenig älter. Das nimmt den Beiträgen zwar nicht ihren Wert (Verständlichkeit ist ja kein Hype-Thema, das man tagesaktuell verfolgen muss). Aber es wäre wirklich schade, wenn das bedeutet, dass das Blog nun still und leise einschläft. Deshalb meine ich diesen Post nicht nur als Leseempfehlung, sondern auch als Ermutigung an die Bloggenden von der HS Luzern: „Wir wollen gerne mehr davon sehen!“

 

Weihnachten, gecheckt! Unser Gutzi 2016

Geht es Ihnen auch so? Ist die ach so besinnliche Adventszeit mit beruflichen und privaten Terminen bis zum Platzen gefüllt? Und wünschen Sie sich auch, dass nächstes Jahr alles besser wird?

Dann haben wir dieses Jahr genau das Richtige für Sie. Denn immer, wenn wir in Stress kommen, dann sorgen wir mit Checklisten für Überblick. Johannes Dreikorn hat das auf der tekom Herbsttagung dieses Jahr anschaulich vorgestellt. Klar, dass wir mit Checklisten auch für mehr Freiraum im nächsten Jahr sorgen wollen.

Und deshalb haben wir Ihnen vier Checklisten gestaltet, damit beruflich und privat alles geschmeidig läuft:

  • eine Checkliste für das Berufliche, mit der Sie die Content-Qualität Ihrer Dokumentation schnell abprüfen können,
  • eine Checkliste für das Team, um die Kaffeemaschine fit zu halten,
  • eine Checkliste für das ganze Jahr, mit der Sie Ihre Einkäufe leichter organisieren und
  • eine Checkliste für Weihnachten 2017, damit die „staade Zeit“ dieses Mal auch wirklich besinnlich wird.

Mit unserem Weihnachts-Gutzi wünschen wir allen unseren Lesern und Leserinnen besinnliche Feiertage und einen guten Start für 2017.