9 Fachbegriffe, die Technische Redakteur:innen kennen sollten

Melina Kininger von

Fachbegriffe Technische Redatkion

Im Fachbereich der Technischen Dokumentation begegnen einem tagtäglich unterschiedliche Fachbegriffe. Gerade wenn Du noch relativ neu in der Technischen Dokumentation bist, kann dies oft zu Verwirrung führen. Daher habe ich Dir in diesem Beitrag 9 wichtige Fachbegriffe in der Technischen Redaktion aufgelistet und erklärt.

Terminologie

Das Wort Terminologie ist besonders wichtig, wenn es um das standardisierte Verfassen von Technischen Dokumentationen geht. Durch eine festgelegte und im nächsten Schritt dann auch korrekt verwendete Terminologie, wird sichergestellt, dass immer die gleichen Wörter verwendet werden.

Lass uns an dieser Stelle einen Blick auf die genaue Definition des Wortes Terminologie werfen: Der Begriff Terminologie beschreibt die Gesamtheit der Fachwörter in einem Themenbereich. So gebe ich Dir in diesem Beitrag zum Beispiel Einblick in die Terminologie des Fachthemas Technische Dokumentation.

Content-Management-System (CMS)

In einem Content-Management-System werden, wie der Name schon sagt, Inhalte gemanagt bzw. verwaltet. Vielleicht kennst Du solche CMS bereits aus der Webseitenerstellung. Denn dort finden diese auch Verwendung. Beispielsweise WordPress ist ein solches CMS. Diese CMS nennen sich dann aber Web-Content-Management-System.

In der Technischen Redaktion wird ein CMS primär mit dem Ziel eingesetzt, das Erstellen von Technischen Dokumenten effizienter zu machen. Ein CMS wird unter anderem für die Aufgliederung von Dokumentationen in einzelne Module bzw. Sinneseinheiten verwendet. Durch diese Aufgliederung können die einzelnen Module in unterschiedlichen Dokumenten wiederverwendet werden. Doppelter Content wird dadurch vermieden, was wiederum eine Menge an Arbeit spart. Aus den einzelnen Modulen können dann im Handumdrehen passende Informationsprodukte generiert werden. In der Technischen Dokumentation wird daher meist von einem Component-Content-Management-Sysetem (CCMS) gesprochen.

Ein CMS wird des Weiteren für folgende Dinge eingesetzt:

  • Trennung von Layout und Inhalt
  • Workflow-Steuerung
  • Versionierung
  • Verwaltung von Inhalten in mehrere Sprachen
  • Arbeiten im Team an den gleichen Inhalten

Single Sourcing

Wenn in der Technischen Dokumentation von Single Sourcing gesprochen wird, ist damit gemeint, dass ein Inhalt an verschiedenen Stellen verwendet wird, er aber nur einmal wirklich vorhanden ist.

Du kannst Dir das so vorstellen: Inhalt A wird in Dokumentation 1 und Dokumentation 2 verwendet. Nun wird der Inhalt aber nicht direkt in die Dokumentationen hineinkopiert, sondern lediglich referenziert. So bleibt sichergestellt, dass der Inhalt nur an einer Stelle seine Quelle hat. Das hat den Vorteil, dass bei Änderungen nicht alle Dokumentationen, in denen der Inhalt A verwendet wird, angepasst werden müssen. Lediglich eine gemeinsame Quelle muss angepasst werden.

Single Sourcing spart Dir einiges an Zeit. Zudem wird die Dokumentationserstellung weniger fehleranfällig, da Du Deine Inhalte immer nur an einer Stelle und einmal anpassen musst. Single Sourcing lässt sich wunderbar über ein CMS (wie oben schon erklärt) umsetzen.

Content-Delivery-Portal (CDP)

Auch hier ist der Name wieder sprechend. In einem CDP werden Inhalte einem Nutzer über das Internet bereitgestellt. Damit ist ein CDP ein Portal, welches dem Leser alle relevanten Informationen zu einem Produkt abrufbar macht.

Das Ziel eines CDP ist es, dem Leser immer genau die Information bereitzustellen, die er benötigt. Damit bieten CDP eine sehr gute Ergänzung zu klassischen Dokumentationen im PDF-Format. Die Informationen werden dem Leser in einem CDP sozusagen Häppchenweise vermittelt. Zugang zu den Inhalten hat der Leser dabei beispielsweise über einen Strukturbaum oder über die Suche des CDPs.

Die Auszeichnungssprache XML

Die Abkürzung XML steht für Extensible Markup Language. XML ist eine sogenannte Auszeichnungssprache zur Dokumentenauszeichnung. Mit dieser Auszeichnungssprache können Daten hierarchisch und strukturiert dargestellt werden. Eine Datei, die mit XML geschrieben ist, kann sowohl vom Menschen als auch von einer Maschine erfasst werden.

Aber wie genau sieht eine Datei aus, die mit XML geschrieben ist? Eine solche Datei besteht aus Inhalten und Textauszeichnungen. Diese Auszeichnungen stehen in spitzen Klammern und heißen Tags. Sie werden um die einzelnen Textpassagen gesetzt. Durch diese Tags kann dem Text in einem späteren Schritt beispielsweise ein spezifisches Layout zugewiesen werden.

Modul

In der Technischen Redaktion ist mit einem Modul ein einzelner Inhalts-Baustein gemeint, welcher in Kombination mit anderen Modulen ein gesamtes Dokument ergibt. Oft wird anstatt von Modul auch von Topic gesprochen. Module kommen dann zum Einsatz, wenn man bei der Dokumentationserstellung eine Wiederverwendung von Inhalten anstrebt.

Die Module werden an einer zentralen Stelle, wie einem CMS, verwaltet und mit Metadaten ausgestattet. Wenn nun zu einem bestimmten Produkt ein Technisches Dokument benötigt wird, können durch die Metadaten die passenden Module ausgewählt (und wiederverwendet werden) und ein ganzes zusammenhängendes Dokument erstellt werden. Die Dokumentationserstellung wird so effizienter.

Standardisierung

Das Wort Standardisierung ist in der Technischen Redaktion sehr wichtig. Durch eine gut durchgeführt Standardisierung kommen nicht nur die Technischen Redakteure schneller zum Ziel, sondern auch die Leser der Technischen Dokumente.

Unter einer Standardisierung wird verstanden, dass alle Inhalte, die in der Redaktionsabteilung vorhanden sind, unter bestimmten Vorgaben und damit einheitlich erstellt werden. Das kann zum Beispiel eine einheitliche Terminologie oder auch eine einheitliche Formulierungsweise von Handlungsaufforderungen sein.

Das Standardisieren von Technischen Dokumenten hat wie bereits beschrieben einige Vorteile. Dazu zählen:

  • schnellere und effizientere Dokumentationserstellung
  • bessere Übersetzbarkeit
  • bessere Verständlichkeit für den Nutzer
  • höhere Qualität der Technischen Dokumente

Cross Media Publishing (CMP)

Beim Cross Media Publishing werden diverse unterschiedliche Austauschformate aus einer gemeinsamen Quelle erstellt. Aus einer Quelle werden somit unterschiedliche Medien bespielt. Hierfür werden die entsprechenden Daten medienneutral erstellt und können hierdurch in verschiedenen Medien ohne erneute Bearbeitung veröffentlicht werden.

Diese medienneutrale Erstellung kann beispielsweise durch die Auszeichnungssprache XML geschehen. Hierdurch wird der Inhalt vom Layout getrennt und die Quelldatei bleibt damit medienneutral. Die Layoutinformationen werden dabei erst zum Zeitpunkt der Publikation hinzugefügt.

Metadaten

Metadaten sind Daten, die einem Informationsprodukt angehängt werden. Sie geben beispielsweise Auskunft über den Inhalt, den Verfasser und sonstige Daten, die wichtig sind. Metadaten bestimmen damit die Position des Informationsprodukts im Informationsraum. Zu dem Thema Metadaten haben wir bereits einen Blogbeitrag geschrieben. Schau gerne dort vorbei, wenn Du mehr erfahren möchtest. Hier gehts zum Blogbeitrag über das Thema Metadaten.

Wie Du siehst, hängen die Fachwörter ziemlich stark miteinander zusammen und werden oft zur Beschreibung der jeweils anderen Wörter verwendet. Wenn Du aber einmal die Basics verstanden hast, wird die ganze Sache schon viel einfacher. Ich hoffe, Du konntest durch diesen Beitrag ein gutes Verständnis der wichtigsten Fachbegriffe in der Technischen Dokumentation bekommen.

Falls Du noch mehr spannende Themen rund um die Technische Dokumentation entdecken willst, schau Dich auf unserem Blog um. Es warten viele spannende Themen auf Dich!

Die 5 wichtigsten Standards in der Technischen Dokumentation

Melina Kininger von

5 Standards für Technische Doku

Standards gibt es in den verschiedensten Lebensbereichen - von der Lebensmittelindustrie bis hin zur Produktion von Kinderspielzeug. Standards gewährleisten Qualität, indem sie Regeln für die Erstellung, Produktion und Bereitstellung von Produkten vorgeben.

Genauso ist es auch in der Technischen Dokumentation. Hier regeln Standards, Richtlinien und Normen die effiziente und qualitativ hochwertige Dokumentationserstellung. Welche Standards, Richtlinien und Normen Du in der Technischen Dokumentation unbedingt kennen solltest, verrate ich Dir in diesem Beitrag.

iiRDS - Standard für intelligente Informationen

Der Standard iiRDS wird immer relevanter in der Technischen Dokumentation. iiRDS umfasst ein Regelwerk für den standardisierten Austausch von intel­ligen­ten Infor­mationen. Die Abkürzung iiRDS steht dabei für „intelligent information Request and Delivery Standard“. Der Standard wurde von einem Konsortium der tekom entwickelt und ist für jeden kostenfrei zugänglich.

Der Standard soll eine dynamische Informationsabfrage- und Lieferung in der Industrie 4.0 ermöglichen. Hierfür wurde eine auf Technische Dokumentation fokussierte Ontologie entworfen. Sie gibt den Rahmen für die Metadatenvergabe vor.

Der Standard schafft eine wichtige Grundlage für modernes Informationsmanagement: Inhalte, Metadaten und (physische) Objekte, wie z. B. das Produkt selbst oder ein Baugruppe, sind eindeutig identifizierbar.

Du möchtest noch mehr über den Standard iiRDS erfahren? Dann schau in unseren Beiträgen iiRDS Best Practice, iiRDS Open Toolkit und iiRDS in Theorie und Praxis vorbei. Dort gibt es viele weitere spannende Informationen rund um iiRDS und dessen Umsetzung in der Technischen Dokumentation.

VDI Richtlinie 2770 - Einfach zum standardisierten Austauschformat

Die VDI Richtlinie 2770 beschreibt ein standardisiertes Austauschformat, das ein effizientes Zusammenführen von umfangreichen Dokumentationen aus unterschiedlichen Quellen ermöglicht und den Zugriff auf Informationen erleichtert. Dafür standardisiert die Richtlinie die Klassifikation, Identifikation, Struktur und das Format von digitalen Herstellerinformationen.

Damit verfolgt die VDI Richtlinie 2770 im Kern das gleiche Ziel wie der Standard iiRDS: Den standardisierten Austausch von digitalen Informationen. Die Richtlinie geht jedoch einen anderen Weg, denn sie legt den Fokus auf ganze Dokumente und schreibt PDF-Dateien als Format vor.

Neben dem standardisierten Austausch ist der einfache Zugang zu digitalen Herstellerinformationen ein Ziel der VDI 2770. Durch die instanzielle Zuordnung von Dokumenten an ein eindeutig bestimmtes Produkt, können Anlagebetreiber benötigte Informationen leichter und schneller finden.

Die Richtlinie ist vor allem für die Verfahrenstechnik und Prozessindustrie sowie deren Zulieferer interessant. Wenn Du wissen möchtest wieso, dann schau in unserem Blogbeitrag zum Thema FAQ zu VDI 2770 vorbei. Auch unsere Beiträge 6 Expertenfragen zur VDI 2770 und VDI-2770-Pakete mit KI halten viele spannenden Infos für Dich bereit.

tekom-Leitfaden für regelbasiertes Schreiben

Ein weiteres und vor allem sehr bekanntes Regelwerk in der Technischen Dokumentation ist der tekom-Leitfaden „regelbasiertes Schreiben“. Dieser Leitfaden ist zwar kein Standard im klassischen Sinne, jedoch gibt er eine konkrete Anleitung zum Schreiben von Technischen Dokumentationen. Du kannst Dir diese Anleitung wie eine Art Nachschlagewerk vorstellen, das Dir (fast) alles mit an die Hand gibt, was Du zum Verfassen von Technischen Dokumentationen brauchst.

Der Leitfaden der tekom wurde speziell für Redaktionsverantwortliche und Informationsentwickler geschaffen, die ihre Dokumentation konsistent und mit einem hohen Qualitätsanspruch verfassen möchten. In dem Leitfaden warten dabei nicht nur Regeln zum standardisierten Schreiben auf Dich. Du findest dort auch Tipps zum übersetzungsgerechten Schreiben, zur Dokumentengliederung oder zur passenden Wortwahl - einfach alles, was eine gute Technische Dokumentation ausmacht.

Klingt interessant? Dann gehts hier zum tekom-Leitfaden „regelbasiertes Schreiben“.

IEC/IEEE 82079-1 - Die wichtigste Norm für Technische Dokumentationen

Wenn Du Dich mit den Standards der Technischen Dokumentation auseinandersetzt, solltest Du auch einen Blick auf die Norm IEC/IEEE 82079-1 werfen. Sie gilt als die zentrale Norm in der Technischen Dokumentation.

Die Norm IEC/IEEE 82079-1 ist sozusagen der Alleskönner unter den Standards und Normen. Sie gibt allgemeine Anforderungen an Technische Dokumentationen vor. Diese Anforderungen betreffen sowohl die Gliederung und den Inhalt der Technischen Dokumentation als auch die gewählte Darstellung. Die Vorgaben, die die Norm schafft, gelten dabei für alle Phasen des Produktlebenszyklus, vom Transport bis hin zu Abfallentsorgung.

Du siehst also, diese Norm ist ganz schön weitreichend. Sie schafft Dir hilfreiche Stützen, wenn es um die Erstellung von Technischen Dokumentationen geht.

ANSI Z535.6 - Warn- und Sicherheitshinweise

Diese Norm ist aus der Technischen Redaktion nicht wegzudenken. Sie ist quasi überlebenswichtig, denn sie gibt konkrete Vorgaben zum Erstellen von Warn- und Sicherheitshinweisen. Dabei gibt die Norm unter anderem vor, wie Warn- und Sicherheitshinweise aufgebaut sein müssen, welche Gefahrenstufen es gibt oder auch in welcher Farbe die Hinweise abzubilden sind.

Wenn Du Dich in Zukunft also an das Erstellen von Warn- und Sicherheitshinweisen machst, solltest Du auf jeden Fall die ANSI Z535.6-Norm parat haben!

Viele weitere Standards

Ich könnte Dir noch viele weitere Standards, Normen und Richtlinien aufzählen, die es in der Technischen Dokumentation gibt. Jedoch sind dies die 5 wichtigsten, die Du kennen solltest. Wenn Du noch tiefer in den Fachbereich der Technischen Dokumentation eintauchen willst, dann schau Dich gerne auf unserem plusmeta-Blog um. Dort findest Du mit Sicherheit den ein oder anderen spannenden Beitrag.

Du hast eine Frage zu einem dieser Standards der Technischen Dokumentation oder dessen Umsetzung? Dann schreib uns eine E-Mail an hallo@plusmeta.de!

VDI-2770-Pakete mit KI

Fabienne Lange von

FAQ zur VDI 2770

Mit unserem Workflow VDI-2770-Pakete erstellen generieren Sie im Handumdrehen Standard-konforme Dokumentationscontainer. Im ersten und zweiten Beitrag dieser Blogserie haben wir typische Fragen aus VDI-2770-Projeken beantwortet. Heute erfahren Sie, wie Sie VDI-2770-Pakete schnell und einfach mit plusmeta erstellen können.

Pakete im Handumdrehen erstellen – geführt von plusmeta

Für die Erstellung von VDI-2770-Dokumentationscontainer gibt es in plusmeta einen speziellen Workflow. Dieser leitet Sie Schritt für Schritt durch die Paketerstellung.

In einem Workflow führt plusmeta in vier Schritten zum fertigen VDI-2770-Dokumentationscontainer.

Schritt 1: Dokumente zuweisen

Im ersten Schritt laden Sie Ihre Dokumente in die plusmeta Plattform hoch. Das geht komfortabel per Drag & Drop.

Da die VDI 2770 die Dokumente in bestimmten PDF/A-Formaten fordert, laden Sie Ihre Dokumente im einfachsten Fall direkt in diesem Format hoch. plusmeta prüft jedes hochgeladene PDF-Dokument auf seine PDF/A-Kompatibilität und zeigt die entsprechende PDF/A-Variante an. So sehen Sie auf den ersten Blick, ob Ihre Dokumente im passenden Format vorliegen. Sollten Ihre PDFs noch nicht dem entsprechenden Format entsprechen, kann plusmeta Sie bei der Konvertierung unterstützen.

Möchten Sie neben den geforderten PDF/A-Dateien auch die Quellformate der Datei (z.B. Excel-Dateien und CAD-Daten) in das Paket übernehmen, lässt das die VDI 2770 in Form sogenannter Formatvarianten zu. plusmeta kann diese Formatvarianten direkt mit der zugehörigen PDF/A-Datei verknüpfen und dadurch eine korrekte Ausgabe der Dateien mit Formatvarianten sicherstellen. Auch die Metadaten werden dabei verknüpft.

Um verschachtelte Pakete zu erzeugen, können Sie auch bestehende VDI-Pakete hochladen. Dabei prüft plusmeta, ob die Pakete richtlinienkonform sind.

xxx

Schritt 2: Metadaten erkennen

Im zweiten Schritt analysiert die Künstliche Intelligenz von plusmeta die Dokumente und vergibt automatisiert passende Metadaten. Welche Metadaten vergeben werden, hängt von der Konfiguration in plusmeta ab. Die Sprache und die VDI-2770-Dokumentkategorie sind vorkonfiguriert und werden standardmäßig vergeben.

Darüber hinaus können in der Konfiguration auch Mappings hinterlegt werden. So können Sie beispielsweise Ihre unternehmensspezifischen Dokumentarten den VDI-2770-Dokumentkategorien zuordnen.

Wenn der KI Ihre Produkte bekannt sind, kann plusmeta bei entsprechendem Vorkommen in den Texten auch die Produktzuordnung vornehmen. Um die Produkte bekannt zu machen, können Sie die relevanten Informationen vorab beispielsweise über den Excel-Import in plusmeta hochladen.

Gibt es eindeutige Kennungen in den Dokumenten oder im Dateinamen wie z.B. die Seriennummer, können diese mithilfe von Extraktoren ausgelesen werden.

Häufig gibt es für zu erstellende VDI-Pakete eine konkrete Bestellung mit Auftragsnummer, Seriennummer, Technischen Plätzen und DIN SPEC IDs. Ist das bei Ihnen der Fall, können Sie diese bekannten Daten als Metadaten-Vorgaben setzen oder per direkter Schnittstelle aus einem anderen System übertragen.

xxx

Schritt 3: Metadaten prüfen und vergeben

Das Ergebnis der Metadatenvorhersage sehen Sie in der Ansicht Metadaten prüfen und vergeben. Hier können die Metadaten geprüft werden und ggf. nötige Änderungen vorgenommen werden. Metadaten, die die KI nicht erkennen kann, ergänzen Sie unkompliziert.

Sie können die Dokumente in der angezeigten Reihenfolge abarbeiten oder über Filter thematisch zusammengehörige Dokumente finden. Wenn Sie Dubletten in den Dokumentensätzen vermuten, kann die Ähnlichkeitsanalyse in plusmeta Aufschluss geben.

Alle Metadaten, die Sie gesichtet haben, nehmen Sie ab. Eine Fortschrittsanzeige an jedem Objekt und eine über das gesamte Projekt visualisieren Ihren Fortschritt. So behalten Sie auch in Paketen mit vielen Dateien den Überblick.

plusmeta prüft kontinuierlich gegen die Vorgaben der Richtlinie und lässt Sie erst in den letzten Workflow-Schritt, wenn alle Anforderungen des Standards erfüllt sind. So wird unter anderem geprüft, dass allen Dokumenten eine Dokumentkategorie und ein instanzieller Produktbezug mit einer eindeutigen Identifikation (z.B. eine Seriennummer oder DIN SPEC ID) zugeordnet ist.

Die Informationen zum Paketersteller bzw. zur verantwortlichen Organisation zieht plusmeta automatisch aus Ihren Organisationseinstellungen.

Weitere in der VDI 2770 vorgesehene Metadaten, wie etwa die „Keywords“ oder die „Summary“ generiert plusmeta automatisch. Dabei ist es auch möglich passende Summary-Texte für Dokumentkategorien und -subkategorien (beispielsweise Zertifikatstypen) zu hinterlegen. Bei Bedarf können Sie die Metadaten aber auch als Freitextfeld hinzufügen oder die Befüllung aus vorhandenen Metadaten triggern. Das geht über Konfigurationen. Die Möglichkeiten stellen wir Ihnen gerne in einer Demo vor.

Im Schritt Metadaten prüfen und vergeben werden die Metadaten gesichtet, bei Bedarf geändert und abgenommen.

Häufig ist im Kontext der VDI 2770 auch die Angabe einer DIN SPEC ID gefordert. plusmeta bietet hier die Möglichkeit, diese automatisiert auf Grundlage von Metadaten wie beispielsweise der Seriennummer zu generieren. Dabei kann auch direkt ein QR-Code erstellt werden.

Bei der Generierung einer DIN SPEC ID, kann plusmeta auch eine Verschlüsselung mit namensbasierter UUID (v5) vornehmen. Da bei dieser Methode auf Grundlage einer bekannte Zeichenkette (z.B. die Seriennummer) verschlüsselt wird, kann die gleiche DIN SPEC ID unabhängig voneinander im plusmeta-Workflow und in der Produktion generiert werden, wo das Typenschild häufig erstellt und angebracht wird.

Die DIN SPEC ID kann automatisiert und verschlüsselt von plusmeta auf Knopfdruck erzeugt werden. Dabei ist im System zu sehen, auf welchem Wert die verschlüsselte ID basiert.

Schritt4: VDI-2770-Paket generieren – Alles verpackt auf Knopfdruck

Wenn alle erforderlichen Metadaten gesetzt und geprüft sind, können Sie im letzten Workflow-Schritt das VDI-2770-Paket generieren.

Im letzten Schritt des Workflows wird das Paket genieriert.

Für jedes angegebene Produkt wird ein Dokumentationscontainer erstellt. Dieser enthält eine PDF- und eine XML-Main-Datei sowie einen Dokumentcontainer für jede PDF-Datei. Im Dokumentcontainer finden Sie außerdem jeweils die passende XML-Datei mit den Metadaten sowie etwaige Formatvarianten.

Das Ergebnis der Generierung ist eine zip-Datei, die nach den Vorgaben der Richtlinien VDI 2770 aufgebaut ist.

Das generierte Paket ist auch bei vielen Dokumenten im Handumdrehen erstellt und steht zum Download bereit.

Sie wollen testweise Ihre eigenen Dokumente im “VDI-2770-Paket erstellen” Workflow sehen? Das zeigen wir Ihnen gerne in einer unverbindlichen Demo.

VDI-2770-Dokumentationscontainer sind ein wichtiger Baustein in der digitalen Datenkette (Stichwort: Digital Data Chain) zum effizienten Austausch digitaler Herstellerinformationen. Mit plusmeta sind Sie ideal vorbereitet.

Ihre Fragen zur VDI 2770 sind noch nicht beantwortet? Dann schreiben Sie uns eine E-Mail an hallo@plusmeta.de!

Mein Praxissemester bei plusmeta

Leon Schiele von

Frohe Weihnachten!

Spannende Monate liegen hinter mir. Mein erstes Praktikum im Bereich Marketing und Technische Dokumentation. Viele neue Eindrücke und neue Leute. Doch wie genau ist mein Praxissemester bei plusmeta abgelaufen?

In diesem Beitrag gebe ich Dir einen Einblick in die Arbeit, die Herausforderungen und den Alltag eines Praktikanten bei plusmeta.

Von der Bewerbung zum Praktikanten

Auf der Suche nach einer geeigneten Stelle für mein Praxissemester, bin ich auf die Seite Workwise aufmerksam geworden. Dies ist eine Plattform, die die Vermittlung zwischen Bewerber und Unternehmen übernimmt. Beim Durchstöbern der Seite stieß ich auf eine Stellenanzeige der plusmeta GmbH. Diese suchte nach einem Praktikanten im Bereich Marketing und Technische Dokumentation. Die Stelle erschien mir wie gemacht für mein Pflichtpraktikum.

Unter Technischer Dokumentation konnte ich mir bis dahin allerdings nicht viel vorstellen. Da die Stellenanzeige jedoch sehr interessant klang, wollte ich mehr erfahren. Ich schickte meine Bewerbung also ganz einfach über die Anzeige ab. Einige Tage später erhielt ich eine Einladung für ein erstes Kennenlerngespräch.

Nach dem ersten Kontakt mit Jan, dem Geschäftsführer von plusmeta, wurde ich für einen Probearbeitstag eingeladen. Hier lernte ich live vor Ort einen großen Teil des Teams kennen und durfte das erste Mal an einem Daily teilnehmen. Auch die ersten kleineren Einführungen und Aufgaben standen an diesem Tag auf dem Plan.

Weiter ging es dann einige Tage später mit der Vertragsunterzeichnung und schon war ich mittendrin.

Die ersten Tage

Zuerst musste ich mich in verschiedene Tools und Prozesse einarbeiten. Dies waren nicht gerade wenige: Dokumentation, verschiedene Bild und Text Bearbeitungsprogramme, Messaging und Planungstools. Deshalb stand die ersten Tage und Wochen vor allem Onboarding auf dem Plan sowie Schulungen, neue Eindrücke und Einführungen in verschiedene Software.

Bei den ganzen neuen Infos und Eindrücken kann der Kopf am Abend schon mal ordentlich rauchen. Ich habe mich jedoch Tag für Tag besser in die Tools und Prozesse eingefunden und schnell gelernt selbstständig zu arbeiten.

Auch die regelmäßigen Absprachen im Daily und Weekly waren anfangs ungewohnt. Im Allgemeinen wird sehr viel Wert auf die Kommunikation untereinander gelegt. In einem „kleinen“ Unternehmen ist das auch sehr wichtig. Aber auch hier fand ich mich schnell ein.

Was sind meine Aufgaben?

Mein Aufgabenfeld ist breit gefächert. Neben dem Dokumentieren und dem Testen der Software ist das Marketing mein Hauptaufgabenbereich. Hier geht es von kleineren Themen wie der Erstellung von Flyern und Grafiken bis hin zum Schreiben von Blogbeiträgen und der Pflege unserer LinkedIn-Seite.

Die große Hauptaufgabe, die mich mein Praxissemester über begleitet, ist der Relaunch unserer Webseite. Diesen betreue ich gemeinsam mit Melina, meiner Marketing-Kollegin. Dabei bekommen wir immer wieder tatkräftige Unterstützung von Jan und Fabienne, die im Bereich Kommunikation und Projekte arbeitet.

Das Mitwirken bei Planung, Konzeption und Umsetzung einer neuen Website sind ganz schön viel Verantwortung für einen Praktikanten. Doch niemand wird hier einfach ins kalte Wasser geworfen. Man lernt nach und nach mit dieser Verantwortung umzugehen und tastet sich langsam heran.

Flexibles Arbeiten

Sowohl bei den Arbeitszeiten als auch bei der bei der Wahl des Arbeitsplatzes hat man bei plusmeta viele Freiheiten. Einige Mitarbeiter von plusmeta arbeiten komplett im Homeoffice, andere sind die meiste Zeit im Büro und arbeiten nur ab und zu aus dem Homeoffice.

Leider zwang mich die aktuelle Corona-Situation im Laufe meines Praktikums mehr und mehr zurück in das Homeoffice. Allerdings ist einem auch hier freigestellt zu wichtigen Terminen in das Büro zu kommen, falls man beispielsweise keine gute Webcam daheim hat. Mir persönlich hat diese Handhabung sehr gut gefallen, man sollte allerdings die nötige Selbstdisziplin mitbringen.

Die Arbeit von Zuhause

Mein Fazit

Die Arbeit ist sehr abwechslungsreich. Selbst als Praktikant wird man aktiv in die Arbeit des Teams integriert. Man bekommt sehr schnell seinen eigenen Verantwortungsbereich. Viele Dinge waren für mich Anfangs zwar neu, doch auch das war mit der Zeit kein Problem mehr.

Die Kollegen sind sehr hilfsbereit und unterstützen gerne, wenn man mal an einer Aufgabe hängt oder einem einfach die Inspiration fehlt.

Etwas schade fand ich es allerdings, als wir von dem Büro-Betrieb zurück ins Homeoffice mussten. Vor allem nach dem großen Umzug in das neue Büro.

Abschließend kann ich sagen, es war ein sehr informatives und spannendes Praxissemester. Ich konnte das im Studium Gelernte super anwenden. Dazu habe ich einen interessanten Einblick in die Arbeitsweisen und den Alltag eines Start-Ups bekommen können. Im Team wurde ich herzlich aufgenommen und fühlte mich zu keiner Zeit alleingelassen. Wenn ich irgendein Problem hatte, wurde ich immer tatkräftig unterstützt. Auch das Vertrauen und die Verantwortung, die mir in die Hände gelegt wurde, weiß ich sehr zu schätzen. Das ist nicht selbstverständlich für ein Praktikum.

Du suchst selbst nach einem Praktikumsplatz oder einer Stelle in einem jungen Unternehmen? Egal, ob es um Software, Technische Dokumentation, Beratung oder Marketing geht:
Schreib uns gerne eine Nachricht an jobs@plusmeta.de! Gemeinsam schauen wir was wir möglich machen können. Vielleicht trittst du bald in meine Fußstapfen als Praktikant.

Wenn du mehr über die Arbeit bei plusmeta erfahren möchtest, lies unseren Blogbeitrag passend zum Thema: plusmeta als Arbeitgeber

Interview: Künstliche Intelligenz in der Technischen Dokumentation, Teil 1

plusmeta GmbH von

Menschliche Hand und Roboterhand bilden ein Herz

Schon heutzutage ist Künstliche Intelligenz in der Technischen Dokumentation verbreitet. Zum Beispiel dann, wenn es um die Vergabe von Metadaten geht. Aber was hat es mit Künstlicher Intelligenz genau auf sich und welche Methoden werden in Technischen Redaktionen schon eingesetzt? Diese Fragen haben Fabienne Lange und Eva-Maria Meier in einem Interview mit Susanne Meier von Quanos Content Solutions im Rahmen der tekom-Jahrestagung beantwortet.

Interview Teil 1: Künstliche Intelligenz und Technische Dokumentation

Frau Lange, Frau Meier, der Begriff „Künstliche Intelligenz“ ist in aller Munde. Können Sie uns erklären, was es mit Künstlicher Intelligenz genau auf sich hat und ob das mehr ist als nur ein momentaner Trend?

Eva-Maria Meier: Künstliche Intelligenz (KI) ist ein Teilgebiet der Informatik, das versucht menschliches Denken und Handeln zu imitieren. Den Begriff klar zu definieren ist schwierig, da die Grenzen zwischen KI und komplexen Algorithmen schwimmend sind. Wir verfolgen ein pragmatisches Verständnis von Künstlicher Intelligenz. Das bedeutet, wir nehmen an, dass es sich um Künstliche Intelligenz handelt „wenn das Ergebnis, das eine Software liefert, intelligent wirkt“.

Das Forschungsfeld gibt es schon sehr lange. Einige Methoden wurden bereits in den frühen 80er-Jahren entwickelt. In den letzten Jahren bekommt das Thema Aufschwung, weil durch größere Rechnerleistung und Cloud-Architekturen mehr Leistung für wenig Geld verfügbar ist. Dadurch können komplexe Modelle verarbeitet werden und Fortschritte erzielt werden.

In der Technischen Kommunikation ist Künstliche Intelligenz seit ca. 2 Jahren ein echtes Trendthema. Das liegt wahrscheinlich auch daran, dass immer mehr Softwareprodukte auf KI setzen.

Würden Sie sagen, dass die Menschen grundsätzlich offen für Künstliche Intelligenz sind oder begegnen sie dieser eher mit einer gewissen Skepsis?

Fabienne Lange: Die meisten Menschen haben in ihrem Alltag bewusst oder unbewusst bereits Kontakt zu KI-Anwendungen. Beispiele dafür sind z.B. Empfehlungen in Streaming-Diensten, Sprachassistenten wie Alexa und Siri, Kontrollmechanismen in Social Media Plattformen, Mail-Spamfilter und Maschinelles Übersetzen.

Im Umfeld der Technischen Kommunikation ist das Thema noch nicht ganz so alltäglich. Hier erleben wir in unserem Arbeitsalltag in erster Linie großes Interesse und Neugier. Allerdings sind wir auch schon mit der Sorge konfrontiert worden, dass Technische Redakteur:innen durch KI-Anwendungen ersetzt werden könnten. Diese Gefahr sehen wir allerdings aus mehreren Gründen nicht. Trotzdem gibt es - wie bei jeder neuartigen Technologie - Menschen, die Künstlicher Intelligenz skeptisch gegenüberstehen.

Die Angst vor der KI, die die Weltherrschaft übernimmt, können wir aber nehmen: Die heutigen Formen Künstlicher Intelligenz können nur das tun, wofür sie erstellt und trainiert wurden. Dabei sollen sie immer eine Unterstützung sein. Ein Werkzeug, das Menschen hilft und aufwendige Arbeiten reduziert.

Es gibt ja unterschiedliche Arten von Künstlicher Intelligenz. Welche Arten gibt es denn, und was bewirken sie?

Eva-Maria Meier: Welche Arten man unterscheidet, hängt von der Perspektive ab. Bei unserem pragmatischen KI-Verständnis unterscheidet man im Wesentlichen zwei Hauptfelder: Die regelbasierten Verfahren und das Machine Learning.

Bei den regelbasierten Verfahren werden Regeln zur Lösung von Problemstellungen programmiert nach dem Muster: Wenn Fall „x“ eintritt, tue „y“. Die Regeln sind kombinierbar und so können komplexe Systeme entstehen, die einen intelligent wirkenden Output liefern. Regelbasierte Verfahren umfassen auch Mustererkennung in Texten über Reguläre Ausdrücke und das Auswerten von Knowledge Graphen.

Anders als bei den regelbasierten Verfahren wird beim Machine Learning der Lösungsweg nicht vorgegeben. Hier lernt die KI aus statistischen Werten und Erfahrungen. Bei der Programmierung werden lediglich die Problemstellung und die Rahmenbedingungen sowie die Information, wie gelernt wird, mitgegeben. All diese Infos stecken in einem Modell. Vielleicht kommen wir darauf später noch einmal zu sprechen.

In den Medien ist in der Regel von Deep Learning die Rede, wenn es um Künstliche Intelligenz geht. Das ist ein Teilgebiet des Machine Learning. Hier werden komplexe Modelle mit vielen Schichten bestehend aus vielen vernetzen Entscheidungspunkten (Neuronen) aufgebaut. Im Prinzip versucht man dabei, das menschliche Gehirn nachzubauen, um komplexe Aufgabenstellungen wie Bilderkennung lösen zu können.

Damit die vielen Schichten gebildet werden können, sind sehr viele Trainingsdaten erforderlich. Hier haben beispielsweise Unternehmen wie Google mit allgemeinen Aufgabestellungen einen großen Vorteil, da sie z. B. alle Bilder aus ihren Online-Cloud-Lösungen zum Training einsetzen können.
Welche Kriterien die Künstliche Intelligenz zur Entscheidungsfindung heranzieht ist nicht einsehbar. Die Netze sind wie eine Blackbox.

Wolke, in der die beiden KI-Formen regelbasierte Verfahren und Machine Learning in jeweils eigenem Kreis dargestellt sind. Im Machine Learning Kreis ist zudem ein weiterer Kreis Deep Learning zu sehen, da Deep Learning zum Machine Learning dazu zählt.

Eine weitere Unterteilungsmöglichkeit für KI ist das „Format“ der zu verarbeitenden Daten. Dann unterscheidet man z. B. zwischen Bilderkennung sowie -klassifikation und Natural Language Processing. Beim Natural Language Processing geht es um das Verstehen und Generieren natürlicher Sprache.

Ein wichtiges Thema in der Technischen Dokumentation ist die Metadatenvergabe. Dort bringt Künstliche Intelligenz mittlerweile eine deutliche Arbeitserleichterung für die Technischen Redakteure. Können Sie erklären, wie die Metadatenvergabe mittels der sogenannten regelbasierten Verfahren funktioniert?

Fabienne Lange: Simpel ausgedrückt wird bei den regelbasierten Verfahren anhand vordefinierter Regeln entschieden, welche Metadaten vergeben werden. In den meisten Fällen wird dabei ein Text mit einer vordefinierten Werteliste abgeglichen. Wenn also beispielsweise ein bestimmtes Wort in einem Text gefunden wird, das in der Werteliste vorhanden ist, dann könnte dieses Wort als Metadatum vergeben werden. Tatsächlich ist die regelbasierte Vergabe aber deutlich komplexer. Hier werden verschiedene Regeln mit Suchmustern kombiniert, die eine genaue Metadatenvorhersage ermöglichen.

So ist unter anderem relevant, wo im Text das Wort gefunden wurde, ob das Wort selbst oder ein Indikator (bspw. ein Synonym) gefunden wurde und ob es sich um einen exakten Treffer oder ein Fuzzy Match handelt. In den meisten Fällen gibt es dabei dann auch mehrere Treffer im Text und die KI entscheidet anhand weiterer Regeln, welcher Treffer am wahrscheinlichsten ist, oder ob sogar mehrere Treffer vorgeschlagen werden.

Darstellung eines Dokuments, aus dem bestimmte Worte ausgelesen und mit Punkten versehen wurden.

Zudem können mithilfe von Wissensnetzen Abhängigkeiten zwischen Metadaten definiert werden oder sogar ganze Produktmodelle als Metadatennetz angelegt werden. Auch diese Wissensnetze können dann regelbasiert ausgewertet werden: Wenn ein bestimmter Wert “A” als Metadatum vergeben wurde, dann vergib auch Wert “B”.

Ein einfaches Beispiel dafür sind die Metadaten „Produkt“ und „Hersteller“. Über ein kleines Produktmodell kann hier ausgedrückt werden, wer das Produkt hergestellt hat. Wird dann das Produkt (z.B. “T3-B”) im Text gefunden, kann auch der Hersteller (z.B. “PI-Fan AG”) als Metadatum mitvergeben werden.

Darstellung eines Wissensnetzes, aus dem bestimmte Metadaten auf Grundlage der Vernetzung ausgelesen werden.

Der große Vorteil dieser regelbasierten Verfahren ist es, dass kein aufwendiges Training erforderlich ist. Mithilfe eines bestimmten Standard-Regelsatzes können die meisten Metadaten vorhergesagt werden. Passt etwas nicht, kann man die Regeln ganz einfach justieren. Am besten funktioniert das bei allen Metadaten, die in irgendeiner Form aus dem Text herausgelesen werden können, wie beispielsweise Produktbezeichnungen, Seriennummern, Baugruppen und Tätigkeiten.

Auch Machine Learning kann bei der Metadatenvergabe unterstützen. Wie funktioniert das genau?

Eva-Maria Meier: Beim Machine Learning benötigen wir immer – wie eingangs schon erwähnt –ein Modell als Basis. Das Modell muss dabei genau für die zu lösende Aufgabe trainiert sein, z. B. zum Erkennen der Dokumentart von PDF-Dateien.

Bei plusmeta arbeiten wir für die Inhaltsklassifikation mit “Überwachtem Lernen”. Beim “Überwachten Lernen” füttern wird die Künstliche Intelligenz mit gelabelten Beispieldokumenten. Wir benötigen dabei für jeden Wert eine kritische Menge an Beispielen aus der die KI lernen kann die Werte zu unterscheiden.

Training eines ML-Modells.

Die KI extrahiert dafür Merkmale. Diese werden gewichtet und fließen in das Modell ein. Welche Merkmale extrahiert werden, wird über einen Algorithmus bestimmt. Die Gewichtung ist dagegen eine veränderbare Stellschraube. Im Modell sind die charakteristischen Punkte für jeden Metadatenwert hinterlegt und in Form eines Vektors gespeichert.

Zeigen wir der KI anschließend unklassifizierte Texte, läuft dieselbe Merkmalsextraktion ab und die KI vergleicht, zu welcher Dokumentart die gefundenen Merkmale am besten passen. Liegt der Vektor des neuen Dokuments z. B. nahe am typischen „Bedienungsanleitungsvektor“, wird dieser Wert vorhergesagt. Die KI ist dabei immer nur so gut, wie das Modell aus dem Training. Es ist also besonders wichtig, die KI mit sehr gut klassifizierten Beispielen zu trainieren.

Trotzdem kann die KI auch mal falsch liegen. Im Feld erreichen wir bei sehr guten Modellen eine Genauigkeit von ca. 92%. Die Ergebnisse müssen daher immer noch einmal von Menschen geprüft werden. Liegt die KI falsch, kann ein Nachtraining mit der Korrektur angestoßen werden. Am besten arbeiten Künstliche Intelligenz und Technische Redakteur:innen also Hand in Hand!

Frau Meier, Frau Lange, vielen Dank für diesen ersten Teil des Gesprächs!

Teil 2 des Interviews folgt bald!

Einsatzmöglichkeiten von Künstlicher Intelligenz sowie Chancen und Grenzen besprechen wir im zweiten Teil dieser Blogserie. Der zweite Teil des Interviews wird im Blog von Quanos veröffentlicht.

Du willst mehr über die Künstliche Intelligenz von plusmeta erfahren oder hast noch eine Frage? Dann schreib uns eine Mail an hallo@plusmeta.de oder besuche unsere Website.