Blog

tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung. mehr ...

tekom-Impressionen Teil 1: Improvisationstechniken, Fluff Hunt und Videos

Auf dem Weg zur Konferenz sehe ich an der Fassade des Stuttgarter Bahnhofs ein Zitat von Hegel: „daß diese Furcht zu irren schon der Irrtum selbst ist“. Genau darum ging es in Anthonys Apodacas Vortrag am Morgen des zweiten Konferenztages. mehr ...

My first time at tekom

I got back from Stuttgart last night and it is safe to say that after three days of action-packed presentations, writing an article is not in the realm of possibilities right now as I try to connect one synapse with another. mehr ...

Eine Tasse auf Reisen #4 - die Auflösung

In welcher Stadt wurde die parson-Tasse fotografiert, haben wir Anfang September gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: In Chicago, USA. mehr ...

Flipped Classroom: Schulungen effizienter gestalten

Es kostet nicht nur Zeit, in einer Präsenzschulung auf die häufig sehr unterschiedlichen Kenntnisse der Teilnehmer einzugehen. Auch besteht die Gefahr, dass sich Teilnehmer mit höheren Vorkenntnissen langweilen, während sich diejenigen mit geringem Vorwissen überfordert fühlen. mehr ...

Warum das Handbuch tot ist

Erinnern Sie sich an Ihr erstes Mobiltelefon? Meins war ein Knochen, dreißig Zentimeter hoch, ein halbes Kilo schwer. Ich konnte damit telefonieren, mehr nicht. Heute habe ich ein Smartphone, mit dem ich manchmal auch telefoniere.

Meistens aber schreibe ich SMS, E-Mails und surfe. So wie sich die Technologie ändert, mit der wir täglich umgehen, so ändert sich auch die Welt der technischen Kommunikation.

Neue Herausforderungen

  • Komplexere Produkte: Nicht nur werden Produkte immer komplexer; es gibt sie auch in immer mehr Varianten. Genauso individuell wie das Produkt muss seine Dokumentation sein, denn jede Produktvariante benötigt ihre eigene Dokumentation.
  • Neue Lesegewohnheiten: Selten lesen wir noch ganze Handbücher. Heutzutage konsumieren wir Informationen häppchenweise. Gezielt suchen wir nach Informationen, die wir gerade benötigen und die zu der Handlung passen, die wir gerade ausführen.
  • Industrie 4.0: Mit dem Zukunftsprojekt Industrie 4.0 wird die Digitalisierung der Fertigungstechnik vorangetrieben. Das Ziel: eine intelligente Fabrik, die wandlungsfähig und ressourceneffizient arbeitet und Kunden und Geschäftspartner in die Geschäfts- und Wertschöpfungsprozesse integriert. Alle Komponenten in einem cyber-physischen System kommunizieren miteinander und mit dem mit dem Werkstück selbst um auf wechselnde Anforderungen und Bedingungen flexibel zu reagieren.
  • Die Dokumentation eines cyber-physischen Systems muss daher berücksichtigen, wie die Komponenten in das Gesamtsystem integriert sind, welche Funktionen und Dienste die Komponente bietet. Auch muss sie Anwendungen wie die Bedienung und die Wartung von Komponenten unterstützen.

All diese neuen Herausforderungen kann die klassische, handbuchorientierte Dokumentation nicht erfüllen. Ist die Dokumentation damit tot? Nein, nur die handbuchartige Anordnung und Auslieferung von Dokumentation. Denn natürlich wird jedes Produkt weiterhin von Informationen zu Anwendung, Wartung und Reparatur begleitet.

Modularität und Metadaten

Dokumentation im Zeitalter von Industrie 4.0 muss modular erstellt werden. Das ist jetzt schon Standard in vielen technischen Redaktionen und wird durch Standard-XML-Architekturen wie DITA oder PI-Mod und XML-Redaktionssysteme unterstützt.

Um die dynamische Zusammenstellung von Informationen für einen bestimmten Anwendungszweck und das Abrufen kleiner, kontextabhängiger Informationshäppchen zu unterstützen, brauchen unsere Dokumentationsmodule außerdem Metadaten. Metadaten verwenden wir als technische Redakteure schon lange, um Dokumente für die Publikation zusammenzustellen oder Module zu suchen.

Neu ist, dass wir diese Metadaten nun zusammen mit unserer modularen Dokumentation ausliefern müssen. Das ermöglicht es Anwendungen, sich aus einer Wissensdatenbank mit modularen Dokumentationsmodulen genau die Häppchen rauszusuchen, die gerade gebraucht werden.

Autoren dieses Blogartikels sind Ulrike Parson und Dr. Achim Steinacker (intelligent views GmbH). Der Artikel erschien am 30. Juli bei Bitkom KnowTech 2015: http://blog.knowtech.net/warum-das-handbuch-tot-ist/.

Kommentar schreiben


  • facebook
  • linkedin
  • xing