Was ist eigentlich Technische Dokumentation?

Was ist Technische Dokumentation?Ist Ihnen der Begriff Technische Dokumentation bekannt? Falls ja, dann haben Sie diesen bestimmt schon jemandem erklären wollen, nur um dann bei „Wo fange ich jetzt eigentlich an?“ oder „Das hat was mit Bedienungsanleitungen zu tun.“ stehenzubleiben.

Vielleicht kann man den Begriff am einfachsten durch einen typischen Entstehungsprozess erklären, also von den Gedanken zur Zielgruppe über die Nutzersituation bis zur Form der Dokumentation. Weiterlesen

Systeme mit System

CCMS, TMS, WCMS, TVS, CLC, AMSIn der Technischen Dokumentation sind wir darum bemüht, Texte und Inhalte allgemein verständlich und in Formulierung und Darstellung konsistent zu gestalten. Dabei nutzen wir diverse Werkzeuge, d. h. in unserem Fall: Software-Systeme, die uns bei der Erstellung und Verwaltung der Inhalte unterstützen. Im Laufe der Zeit hat sich eine ganze Palette von Systemen herausgebildet, die jeweils auf bestimmte Teilaufgaben spezialisiert sind. Und natürlich hat jedes dieser Systeme seine eigene Bezeichnung, und zusätzlich noch eine Abkürzung, was zu einer terminologischen Vielfalt führt, für die man fast schon wieder ein eigenes Verwaltungssystem bräuchte … Heute bringen wir Ordnung in dieses Dickicht und stellen die wichtigsten Systeme im Bereich der Technischen Dokumentation vor – mit System.

Weiterlesen

Fehlermeldungen, die wirklich weiterhelfen

Fehlermeldungen in Apps und Websites richtig schreiben„Warum funktioniert das nicht?“ „Was ist denn jetzt schon wieder?“

Diese Gedanken kommen schon mal auf beim alltäglichen Umgang mit Apps, Websites und Programmen. Auch wenn man sie ungern sieht: Eine Fehlermeldung hilft an dieser Stelle weiter – wenn sie gut ist.

Vor kurzem hatten wir bei doctima die Aufgabe, für einen Kunden Fehlermeldungen für eine App zu erstellen. Der erste Gedanke: „So schwer kann das gar nicht sein. Wir schreiben ja auch Sicherheitshinweise und eigentlich ist das ganz ähnlich.“ Eigentlich – und eigentlich auch wieder nicht, denn Fehlermeldungen benötigen eine etwas andere Expertise. In diesem Blogpost gebe ich einen kleinen Einblick in unsere Erfahrungen mit diesem spannenden Thema und ein paar Tipps, wie Sie selber gute Fehlermeldungen erstellen. Weiterlesen

Karriere in der Technischen Redaktion: Von der Uni ins Berufsleben

Karriere Technische RedaktionVor ein paar Wochen haben wir hier im Blog darüber geschrieben, worauf Bewerber achten sollten, wenn sie sich in Technischen Redaktionen – speziell hier bei doctima – bewerben wollen. Heute kommen diejenigen zu Wort, die die Bewerbungsphase schon eine Weile hinter sich haben: Ulrike, Maria und Lisa haben alle an der Hochschule Merseburg studiert und sind seit ein paar Jahren bzw. Monaten im Team doctima als Technische Redakteurinnen mit ganz unterschiedlichen Aufgaben. Sie erzählen, was sie konkret machen und wie der Einstieg ins Berufsleben als Technischer Redakteur so lief. Weiterlesen

Datenschutzgrundverordnung: (K)ein Thema für die Technische Dokumentation

Die DSGVO spielt auch in der Technischen Dokumentation eine Rolle.Wie haben Sie den 25. Mai verbracht? Wenn Sie selber Unternehmer sind oder in einem Unternehmen für den Datenschutz zuständig sind, gibt es eigentlich nur ein paar mögliche Geisteszustände: erschöpft, verwirrt und genervt.

Seit dem 25. Mai ist die neue europäische Datenschutzgrundverordnung (DSGVO) gültig. In Kraft trat sie bereits 2016. Erst in den letzten Wochen waren deutliche Erschütterungen im Internet und in so manchen Büros  zu spüren. Auch bei uns gab und gibt es ein paar graue Haare mehr oder insgesamt ein paar Haare weniger, denn das Thema ist schon ein wenig zum Haareraufen. Doch was ändert sich jetzt mit der neuen DSGVO und wieso ist die neue Verordnung auch für die Technische Dokumentation ein Thema? 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

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

tekom 2017, die Doku-Branche zu Besuch in Stuttgart

Vier Wochen ist es her, dass wir auf der tekom-Jahrestagung 2017 waren. Viel ist seitdem passiert, wir sind schon voll im konkreten Austausch mit Kontakten von der Tagung. Dazu beigetragen hat sicherlich unser iiRDS-Szenario mit unserem Roboterarm. Einerseits Eyecatcher, andererseits die anschauliche Darstellung, wie automatisierte Prozesse und Informationsflüsse in Unternehmen heutzutage ablaufen. Weiterlesen

tekom 2017 – Sehen wir uns nächste Woche?

doctima auf der tekom-Jahrestagung (c) doctima

Mit großen Schritten gehen wir auf die tekom-Jahrestagung 2017 zu. Heute in einer Woche startet die Konferenz nebst Messe. Insgesamt geht es dann von Dienstag, 24.10.2017, bis Donnerstag, 26.10.2017, in der Messe Stuttgart um Technische Kommunikation und alle dazugehörigen Fachthemen. Weiterlesen

Tipps zum Umgang mit KPI in der Redaktion

Controller machen Freude -auch in der Redaktion

Nachdem ich letzte Woche so eindeutig eine Lanze für mehr Controlling in der Technischen Redaktion gebrochen habe, möchte ich heute noch ein paar Tipps mitgeben, worauf man am besten beim Entwickeln der Kennzahlen achtet und wie man die Kennzahlen in die Arbeitsprozesse einbindet.

Kennzahlen müssen wirken

Sobald Sie Ihre strategische Ausrichtung geklärt haben, geht es daran, die konkreten Kennzahlen (KPI) festzulegen. Viele Redaktionen lassen sich hier von der Begeisterung überrollen. Daten als mögliche Grundlage für die Auswertung fallen in einer modernen Redaktion en Masse an. Was liegt also näher, als sich diesen Datenbestand einmal anzusehen und alle interessanten Daten auszuwerten?

Wenn Sie so vorgehen, haben Sie bereits den ersten Schritt getan, damit Ihr Controlling scheitert. Denn interessant heißt nicht relevant. Noch einmal zur Erinnerung: KPI müssen immer an ein strategisches Ziel rückgebunden sein, sonst entfalten Sie keine Wirkung.

Ein Beispiel

Das Maschinenbauunternehmen DeusEx plant eine Digitalisierungs-Offensive. Dazu soll die Dokumentation direkt an den Maschinen zugänglich gemacht werden. In diesem Fall ist es sicher interessant zu wissen, wie groß der Dokumentationsbestand der Abteilung aktuell ist und wie viel Dokumentation monatlich produziert wird. Mit dem Ziel hat das aber nur wenig zu tun. Besser ist es da schon, die Zahl der Dokumente festzuhalten, die digital bereitstehen. Ich würde meinen Messpunkt aber noch ein wenig anders gewichten und die Zahl der Maschinen erfassen, die mit digitaler Dokumentation ausgeliefert sind. Dadurch wird nämlich auch automatisch deutlich, auf welche Maschinentypen sich die Redakteure der Firma DeusEx bei der Umstellung konzentrieren sollten.

Aufwand im Blick

Denn wenn Kennzahlen nicht handlungsrelevant werden, sind sie ein typisches Schönwetter-Phänomen: Sobald die Arbeitsbelastung steigt, kümmert man sich nicht mehr um sie, weil man ja „richtige“ Arbeit zu erledigen hat. Wichtiger als möglichst viele Daten zu erfassen, ist es aber, dass Sie Ihre Daten kontinuierlich und zuverlässig erheben.

Das unterstreicht deutlich, dass man bei der Auswahl der Kennzahlen den Aufwand für die Erfassung im Blick behalten sollte – und zwar nicht nur im Alltagsbetrieb, sondern auch unter Hochlast. Idealerweise werden die Daten automatisiert erhoben und in einem Informationssystem zusammengefasst. In der Realität muss man aber doch immer wieder selbst Hand anlegen.

Kommen wir noch einmal auf unser Beispiel von oben zurück: Ich hatte ja empfohlen, die Zahl der ausgelieferten Maschinen in die Auswertung zu nehmen. Was aber nun, wenn ich als Redaktionsabteilung an diese Zahlen nur schwer komme, z. B. weil sie nur länderweise erfasst werden und ich sie erst aggregieren muss? Dann würde ich mich für das ungenauere Maß „Zahl der digital bereitstehenden Dokumente“ entscheiden. Denn das kann ich ohne Abstimmungsaufwand in den Prozessen der Dokumentationsabteilung erheben. Also: Im Zweifelsfall lieber ein etwas ungenaueres Maß, das sich leicht erheben lässt, als ein aufwändiges Maß, das etwas präziser ist.

Für wen machen wir das eigentlich?

Apropos Kommunikation mit anderen Abteilungen: Wer sollte denn Ihre Kennzahlen bekommen? Eine pauschale Antwort darauf gibt es nicht. Wie auch die Kennzahlen selbst hängt das von Ihren Zielen ab. Aber ein paar Ansatzpunkte gibt es schon:

  1. Ihr Chef:
    denn Ihre Kennzahlen sollten zeigen, dass Ihre Abteilung rund läuft, sich auf dem richtigen Weg befindet oder – wenn das nicht so ist – wo es gerade hakt und was man dagegen tun kann.
  2. Ihre Geldgeber:
    denn nichts überzeugt bei Budgetverhandlungen so sehr wie harte Fakten. Geldgeber müssen Sie vielleicht nicht laufend informieren, aber fallweise z. B. vor und während einer Software-Einführung.
  3. Ihre Datenlieferanten:
    denn wer Ihnen Datenmaterial zukommen lässt (z. B. die Sales-Abteilung in unserem Beispiel), hat vermutlich auch ein Interesse an Ihren Ergebnissen (z. B. als Verkaufsargument).

Und wenn Sie wissen, wem Sie welche Kennzahlen zukommen lassen wollen, dann überlegen Sie sich doch auch gleich noch, wie oft. Auch hier gilt: So selten wie möglich, aber so häufig, dass der Prozess kontinuierlich am Laufen bleibt.

Und wie geht es weiter?

Falls Sie sich jetzt sagen, „Das stimmt schon alles, aber wo fängt man jetzt am besten an?“, dann kann ich das gut verstehen. Denn: Jedes Unternehmen und jede Redaktion ist unterschiedlich, hat individuelle Ziele, Prozesse und Tools. Deshalb meine Empfehlung: Tauschen Sie sich mit anderen aus! Zum Beispiel mit Kollegen aus Ihrem Redaktionsteam, die sicher eigene Ideen und Vorschläge zu diesem Thema haben. Oder mit den Marketing-Leuten Ihres Unternehmens; die haben oft schon Kennzahlen für sich implementiert und können ihre Erfahrungen weitergeben. Oder auf Branchenveranstaltungen mit den Technischen Redakteuren aus anderen Unternehmen. Und wenn Sie professionelle Unterstützung bei der Einführung Ihres Kennzahlensystems suchen, dann wissen Sie jetzt ja, wer Ihnen weiterhilft.