Software-Anleitungen verständlich schreiben (Buchrezension)

Buchcover "Software-Anleitungen verständlich schreiben"Bis vor kurzem habe ich für doctima in einem großen Softwareunternehmen gearbeitet. In dieser Zeit habe ich Software-Anleitungen in einem CMS geschrieben und gepflegt, an Konzepten gefeilt und mein Augenmerk auf Verständlichkeit gelegt. Deshalb machte mich der Titel des neuen Buchs von Dietrich Juhl sofort neugierig: „Software-Anleitungen verständlich schreiben. Konzepte, Strukturen, Beispiele“. Ich fragte mich: Welche Herangehensweisen zeigt dieses Buch auf, an die ich noch gar nicht gedacht habe? Inwiefern deckt meine Praxiserfahrung sich mit der des Autors? Weiterlesen

Persona-Software, die zweite

Vor Kurzem hatte ich hier Softwarelösungen für die Erstellung von Personas gezeigt. Ein Software-Paket bin ich allerdings schuldig geblieben: Persona von Marinersoft. Mittlerweile habe ich gemerkt, dass es sich schon in meinem Downloads-Ordner befunden hat. Ohne Mail und Double-Opt-in – heutzutage eher ungewöhnlich, aber was soll’s. Ich habe mir das Paket also einmal installiert und reiche hier wie versprochen meine Eindrücke nach. Weiterlesen

Persona-Software im Test

Persona-Software im TestPersonas sind ein verbreitetes Mittel zur Zielgruppendefinition und -orientierung. Auch in der Technischen Redaktion werden Personas eingesetzt, um leichter zu entscheiden, welche Inhalte, Medien und welcher Stil für eine bestimmte Zielgruppe geeignet sind.

Für die meisten Nutzer bedeuten Personas eine Menge Handarbeit. Gut zu wissen, dass es durchaus auch Progamme zur Persona-Erstellung gibt. Ich habe mir hier mal ein Angebot angesehen, mit denen die Persona-Erstellung schnell und effizient vonstattengehen soll. Weiterlesen

Tipps für eigene Word-Vorlagen in der technischen Dokumentation

Eigene Word-Vorlagen sind in der technischen Dokumentation sinnvoll.Vor ein paar Tagen erst habe ich letzte Hand angelegt an eine Word-Dokumentvorlage, die ich für einen Kunden aus dem Maschinenbausektor erstellt habe. „Was? Ihr arbeitet als Kommunikations-Profis noch mit Word?“, werden Sie sich vielleicht fragen. Ja, das tun wir – und vor allem tun es auch unsere Kunden.

Für „echte“ Dokumentationsprojekte verwenden wir Word nur noch sehr selten, da sind meist Profi-Tools im Einsatz, vor allem Content-Management-Systeme wie SCHEMA ST4. Aus dem Alltag der sonstigen technischen Textsorten wie Lasten- und Pflichtenhefte ist Word als Werkzeug aber lange noch nicht wegzudenken. Weiterlesen

6 Gründe für ein (C)CMS

Gründe für ein Content Management System

Mit einem Content Management System können Sie Ihre Inhalte flexibel zusammensetzen.

Etwa die Hälfte der Technischen Redaktionen verwendet ein Content Management System (CMS), die andere Hälfte behilft sich jedoch noch immer ohne Redaktionssystem. In unserem Beitrag zeigen wir, welche Argumente für ein CMS sprechen und was das Ganze mit Industrie 4.0 und Digitalisierung zu tun hat. Weiterlesen

Digital oder Papier? Vorteile der mobilen Dokumentation

Mobile Dokumentation per App hat viele Vorteile gegenüber Papier.

Digitalisierung, Industrie 4.0 und das Internet of Things verändern auch die Art, wie wir über Technische Dokumentation denken. Eine der ersten Maßnahmen auf dem Weg zu „Information 4.0“ ist es, die Dokumentation weg von der Kapitelstruktur themenbezogen zu strukturieren und sie mithilfe von Metadaten semantisch zu markieren.

Anstatt Handbücher auf Papier oder als A4-formatierte PDF-Datei auszuliefern, erzeugen wir auf dieser Basis dynamische Informationen in HTML5, die sich auf unterschiedlichen Displays, auf Maschinenkonsolen oder auf Mobilgeräten verteilen und betrachten lassen. Weiterlesen

Usability und Technische Dokumentation – aus einem Guss

Das Buch, das ich mir heute vorgenommen habe, füllt – zumindest dem Anspruch nach – eine Lücke, die ich seit Längerem beklage: Technische Dokumentation und Produkt gleichermaßen aus dem Blickwinkel der Usability zu betrachten. Die Autorin Getrud Gründwied ist Professorin für Technische Dokumentation und Usability an der Hochschule München. Sie weiß also, wovon sie schreibt. Aber: Ist das Buch auch für Praktiker verwendbar?

Inhalt

Grünwieds Buch ist als Handbuch angelegt. Es verspricht damit Entwicklern, IT-Spezialisten und Technischen Redakteuren einen strukturierten Einstieg in das weite Themenfeld der Usability. Und ich muss sagen das gelingt auch voll und ganz. Ausgangspunkt ihrer Einführung ist für Grünwied der zunehmende Trend zur Digitalisierung von Produkten und Dienstleistungen. Im ersten Moment erschien mir das ein wenig weit hergeholt und mich beschlich eine leichte Ahnung von Buzzword-Dropping. Schließlich ist Usability in der  Dokumentation schon seit den Achtzigern ein Thema. Aber Grünwied legt anschaulich und plausibel nahe, wie Usability unter den Bedingungen der Digitalisierung zu einem entscheidenden Erfolgsfaktor wird, der sich weder bei Produkten noch bei der Produktkommunikation noch länger ignorieren lässt.

Die weiteren Informationen baut Grünwied dann didaktisch sinnvoll auf. Nach einem Grundlagen-Kapitel, das die verschiedenen Aspekte der Usability darstellt, zeigt sie die verschiedenen Prozessmodelle, in denen heute Produkte, Software und Technische Dokumentation entwickelt werden. Besonders wichtig war mir das darauffolgende Kapitel zu Nutzer- und Nutzungsforschung. Ich beschäftige mich seit langem damit und kann sagen, dass ich dieses Thema selten so strukturiert dargestellt gesehen habe. Nach einem kurzen Kapitel zur Gestaltung (bzw. zu Methoden um eine nutzbare Gestaltung zu finden) geht sie schließlich auf die Evaluation der Usability ein.

In diesen drei Kernkapiteln schildert Grünwied anschaulich und doch dicht eine Vielzahl von Methoden aus dem Usability-Bereich. Hier bestünde allerdings die Gefahr, dass die Materie in theoretischen Erklärungen stecken bleibt. Deshalb ist es nur konsequent, dass die Autorin das Buch mit zwei Praxiskapiteln abschließt: Kapitel 8 beschäftigt sich mit dem Anwenden der Methoden und Kapitel 9 zeigt drei ausführliche Fallstudien.

Präsentation

Insgesamt ist das Buch ansprechend gestaltet mit einem klaren Druckbild und einer haptisch gefälligen Papierqualität. Grafiken, Tabellen, Text-Inserts mit Hintergrundinformationen lockern das Schriftbild des Handbuchs auf. Die Informationen sind dadurch in kleine überschaubare Einheiten gegliedert und lassen sich leicht erfassen. Zur Verständlichkeit tragen auch sogenannte „Checklisten“ bei. Dahinter verbergen sich aber keine Checklisten im eigentlichen Sinn, sondern Kurzzusammenfassungen in Listenform. Hilfreich, aber eigentlich hatte ich mir etwas Anderes erwartet von den Checklisten, die auf dem Buchcover versprochen wurden.

Ähnlich geht es mir mit dem weiterführenden Material. Mit Endnoten (ist das nicht ein wenig „Old-School“?), einem umfangreichen Softwareverzeichnis und einem kurzen, thematisch geordneten Literaturverzeichnis findet der Leser eigentlich ausreichend Anknüpfungspunkte zur Vertiefung. Aber wieso gibt es keine Hinweise auf Webressourcen? Empfehlenswerte Usability-Blogs gibt es zuhauf, genau wie Youtube-Channels und Twitteraccounts von Usability-Experten. Und weil wir schon beim Thema Webressourcen sind: Warum gibt es keine ergänzende Website, in der man sich interaktive Beispiele herunterladen kann und  die über eine Linksammlung bequem zu Webressourcen führt? Bei all diesen Punkten nimmt das Buch seinen Anspruch, Digitalisierung voranzutreiben, nicht ernst genug. In einer nächsten Auflage sollte der Verlag hier auf jeden Fall nachbessern.

Fazit

Grünwieds Buch hält definitiv, was es verspricht. Es schafft den Spagat sowohl Entwicklern als auch Technischen Redakteuren einen Einstieg in das mittlerweile ziemlich unübersichtliche Thema Usability zu geben. Zwar hätte man bei dem Buchkonzept – insbesondere bei diesem Thema – einer modernen, digitalen Zielgruppe in ihren Rezeptionsgewohnheiten noch mehr entgegenkommen können. Dem Gesamteindruck tut das aber keinen wesentlichen Abbruch – eindeutige Lese-Empfehlung für alle Neulinge im Themenfeld Usability.

Literatur:  Grünwied, Gertrud [2017]: Usability von Produkten und Anleitungen im digitalen Zeitalter. Handbuch für Entwickler, IT-Spezialisten und technische Redakteure. Mit Checklisten und Fallstudien. Publicis Verlag, Erlangen. ISBN 978-3-89578-464-4.

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.

Weltweit erfolgreich mit Single Source Publishing

Hilscher Produktseite

Hilscher Produktseite

Unser Kunde Hilscher als Hersteller von Komponenten für Industrienetzwerke agiert weltweit. Um seine wichtigsten Märkte optimal zu versorgen, pflegt Hilscher seine Website in sieben Sprachen. Sie zeigt unter anderem ein vollständiges, aktuelles Produktportfolio mit 1500 Produkten. Der Effekt dieser umfassenden Kommunikationsleistung ist messbar: bereits im ersten Jahr nach dem zurückliegenden Relaunch verdoppelten sich die Besucherzahlen des Internetauftritts. Dennoch bleibt der Gesamtaufwand für die Verwaltung der Inhalte überschaubar, die Website wird von zwei Mitarbeitern nebenbei betreut. Wie das gelingt, möchte ich in diesem Beitrag schildern.

Produktinformationen mit Single-Source-Ansatz

Detaillierte Informationen zu den einzelnen Produkten machen bei Hilscher das Gros des Website-Contents aus. Diese Inhalte werden nicht direkt im Internet-CMS TYPO3 gepflegt, sondern über einen Connector aus dem Redaktionssystem SCHEMA ST4 dort eingespielt. Es gibt eine Reihe von Gründen, die Produktbeschreibungen in dem für Single-Source-Publishing ausgelegten Redaktionssystem zu pflegen:

1. Mehrfachverwendung

Der naheliegendste Grund: Aus denselben Produktinformationen werden u. a. auch gedruckte Datenblätter erstellt. Um Konsistenz zu gewährleisten und Doppelarbeit zu vermeiden, ist da eine gemeinsame Datenquelle unabdingbar. Mit den HTML- und PDF-Ausgabmechanismen von ST4 lassen sich beide Formate auf Knopfdruck generieren.

2. Modularisierung

Eine Produktbeschreibung ist ein hochgradig strukturiertes Dokument. Sie besteht aus einem festgelegten Satz von Textbestandteilen wie Features, technischen Daten oder Bestellinformationen (Beispiel). Einige dieser Bausteine können dabei für ganze Produktgruppen identisch sein, wofür sich der Wiederverwendungsmechanismus des Redaktionssystems anbietet. Web-CMS sind nicht unbedingt für die Verwaltung dieses Komplexitätsgrads ausgelegt. TYPO3 erlaubt es immerhin, eine Seite aus mehreren Content-Elementen aufzubauen, aber Bearbeitung und Übersetzung verlieren schnell an Übersichtlichkeit.

3. Metadaten

In ST4 is es ein Leichtes, jedes Produkt mit Eigenschaften bzw. Metadaten zu versehen, die sich automatisiert aus dem Produktdatenmanagement übernehmen lassen. Im Internetauftritt entsteht mit diesen Informationen nützliche Zusatzfunktionalität. Bei Hilscher haben wir einen Technologiefilter (Beispiel) und einen kriteriengesteuerten Produkt-Finder implementiert. Beide Mechanismen erleichtern es dem Anwender, die für seine Zwecke richtigen Produkte zu identifizieren.

4. Übersetzungsmanagement

Die Produktbeschreibungen werden mithilfe von TRADOS in einer Agentur übersetzt. Die COTI-Übersetzungsschnittstelle von ST4 erlaubt eine zügige, kosteneffiziente Abwicklung der Übersetzungen und stellt mit seinem Übersetzungsreport ein mächtiges Werkzeug for die Qualitätssicherung zur Verfügung.

5. Qualitätssicherung

Der Abgleich nach TYPO3 aus dem ST4 erfolgt automatisiert über die von doctima entwickelte Standard-Schnittstelle ContentConnect, die Fehlerbehandlung, Datenmodellabgleich und Reporting mitbringt.

Redaktionsarbeit in TYPO3

Überblicksinformationen und Unternehmensbeschreibung sind in der Regel Freitext und lassen sich deshalb leichter als die Produktinformationen im Web-CMS verwalten. Auch sind bei diesen Texten die Nutzeffekte kleiner, die sich z.B. aus Modularisierung und Wiederverwendung ergeben. Deshalb werden diese Informationen direkt in TYPO3 gepflegt.

Um auch in TYPO3 ein systematisches Übersetzungsmanagement zu implementieren, haben wir die vorhandene Extension Localization Manager von Loctimize in Abstimmung mit der Übersetzungsagentur unseres Kunden angepasst.

Aus dem Produktivbetrieb

Das oben beschriebene Setting befindet sich mittlerweile seit einiger Zeit erfolgreich im Produktivbetrieb und die Projekterwartungen konnten vollständig realisiert werden. Neben den erhofften Nutzeffekten haben sich für unseren Kunden aber immer wieder auch unerwartete Benefits ergeben. Ein Beispiel: Wir hatten den  automatisierter Import von Inhalten und verknüpften Metadaten eigentlich für die Produktfinder-Funktion gedacht. Nebenbei liefert er aber systematisch Keywords und verbessert damit u.a. die Statistik-Auswertung von Marketing-Aktionen. Fazit: Wenn sich Dokumentation und Marketing enger zu verzahnen, steht dem weltweiten Erfolg nichts mehr im Weg.

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.

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.