Glossar

A

Annotation

Metadaten, mit denen Informationen oder Daten mit zusätzlichen Informationen angereichert werden, die deren Bedeutung näher beschreiben. Im Semantic Web nutzen Softwareanwendungen die Metadaten, um auf die Bedeutung von Informationen zuzugreifen und diese zu interpretieren.

API

Application Programming Interface, d. h. Programmierschnittstelle. Ermöglicht den Zugriff auf die Funktionen eines Systems oder einer Softwareanwendung durch andere Softwareanwendungen.

AsciiDoc

Vereinfachte Auszeichnungssprache für Texte, die oft zur Dokumentation der Softwaredokumentation verwendet wird. Aus AsciiDoc können verschiedene Dokumentenformate erzeugt werden, u. a. PDF und HTML.

B

Blended Learning

Lernmodell, in dem computergestütztes Lernen, z. B. über das Internet, und klassischer Unterricht kombiniert werden.

C

CCMS

Component Content Management System. Ein Redaktionssystem, in dem modulare technische Dokumentation erstellt und verwaltet wird. Module können Texte, Textabschnitte, Bilder oder andere Medien sein. In einem CCMS sind Inhalte vom Layout getrennt, es können daher mehrere Ausgabeformate erzeugt werden, z. B. PDF-Dokumente oder Online-Hilfen. CCMS bieten zusätzlich Funktionen zur Varianten- und Workflowsteuerung sowie zum Übersetzungsmanagement.

Concept

Topic-Typ in DITA, der die „Was-ist-das-Frage“ beantwortet. Concepts werden für allgemeine Definitionen und Erklärungen verwendet und liefern Hintergrundinformationen über ein Produkt oder andere für das Verständnis wichtige Informationen.

Content-Delivery-Portal

Web-basierte Softwarelösung für die Präsentation und das inhaltliche Erschließen umfangreicher Informationen und Dokumente. Die mit Metadaten angereicherten Inhalte unterstützen das zielgruppen- und kontextabhängige Filtern von Informationen und semantische Suchabfragen. Die Inhalte selbst werden in der Regel nicht im Portal erstellt, sondern kommen aus einem oder mehreren Autorensystemen.

Content-Engineering

Methode, bei der Inhalte Technischer Dokumentation entsprechend einer Informationsarchitektur organisiert, strukturiert und mit Metadaten angereichert werden.

Content-Lieferkette

Auch Content-Supply-Chain. Umfasst den gesamten Prozess, in dem Inhalte geplant, erstellt, verwaltet, personalisiert und auf die Zielgruppe zugeschnitten werden.

Content-Strategie

Definiert unternehmensweite Richtlinien zur Erstellung, Verwaltung und Veröffentlichung von Inhalten aus verschiedenen Unternehmensbereichen.

Continuous-Integration

Eine Methode der Softwareentwicklung, bei der Änderungen an Inhalten (Quellcode, Dokumentation u.a.) kontinuierlich in eine zentrale Versionsverwaltung integriert werden, anstatt gesammelt am Ende eines Entwicklungszyklus.

D

Digitaler Informationszwilling

Digitales Modell für alle Informationen zu den Komponenten, Funktionen, Prozessen und Dokumentationen zu einem technischen Produkt oder System über dessen gesamten Lebenszyklus. Repräsentiert ein Netz von verknüpften Informationen, das u. a. Produktmerkmale, Produktvarianten, Dokumentarten, Informationsthemen, Topic-Arten und Zielgruppen und deren Zusammenhänge beschreiben kann. Der digitale Informationszwilling kann z. B. verwendet werden, um zu einer Produktkonfiguration die passende technische Dokumentation zusammenzustellen.

Digitaler Zwilling

Digitales Abbild eines materiellen oder immateriellen Objekts aus der realen Welt, z. B. einer Maschine oder technischen Anlage. Der digitale Zwilling enthält Modelle des abgebildeten Objekts und verbundener Prozesse und kann zusätzlich Simulationen, Algorithmen und Services enthalten, die Eigenschaften und Verhalten von Objekten und Prozessen beschreiben. Er ermöglicht die Simulation, Steuerung und Verbesserung des repräsentierten Objekts und seines Verhaltens.

DITA

Darwin Information Typing Architecture. Informationsarchitektur auf XML-Basis, die speziell für die Technische Dokumentation konzipiert wurde. Grundlage von DITA ist die Aufteilung von Inhalten in Bausteine, sogenannte Topics. Jedes Topic befasst sich mit einem bestimmten Thema.

DITA OT

DITA Open Toolkit. Open-Source-Tool für DITA, mit dem DITA-Inhalte in verschiedenen Formaten ausgegeben werden können, z. B. PDF, XHTML oder ODT.

DocBook

Frei verfügbares Informationsmodell, das in einer für SGML und XML vorliegenden Dokumenttypdefinition (DTD) festgelegt ist und eine vorwiegend sequenzielle, buchähnliche Struktur für verschiedene Dokumentationsinhalte bietet. Als offener und breit angelegter Standard für verschiedene Dokumentationsarten bietet DocBook u. a. semantische Elemente für Soft- und Hardware-Dokumentation und ist weit verbreitet bei Open-Source-Projekten.

Docs-as-code

Methode, bei der Technische Dokumentation in derselben Umgebung und mit denselben Methoden gepflegt wie Quellcode. Dabei werden auszeichnungsarme Sprachen wie AsciiDoc oder Markdown als Dokumentationsformat verwendet, aber auch XML.

DTD

Document Type Definition. Regelsatz für XML-Dokumente eines bestimmten Typs. Definiert die gültigen Elemente und Attribute in einem XML-Dokument und legt fest, wie diese verwendet werden und welche Unterelemente sie enthalten dürfen.

F

Folksonomy

Derivation aus den Wörtern folk und taxonomy, auch Social Tagging. Freie Schlagwortsammlung, die entsteht, wenn viele Nutzende einen Text gemeinsam erstellen oder bearbeiten und mittels Tags (Schlagwörtern) den Inhalt strukturieren und kennzeichnen.

H

Heuristische Analyse

Spezielle Untersuchungsmethode, mit der u. a. die Nutzungsfreundlichkeit (Usability) von Produkten wie Websites, Software oder Dokumentationen bewertet wird. Eine Sammlung allgemein anerkannter Prinzipien (Heuristiken) dient als Checkliste zur Bewertung der Usability, mit der Schritt für Schritt ein Produkt getestet wird.

I

IDE

Integrated Development Environment (integrierte Entwicklungsumgebung). Eine Sammlung von Anwendungen für die Software-Entwicklung, die Editor, Compiler, Debugger und andere Komponenten enthält und in einer grafischen Oberfläche miteinander vereint.

iiRDS

intelligent information Request and Delivery Standard. Standard für die Auslieferung von technischer Dokumentation und anderer Informationsarten als intelligente Informationen. iiRDS definiert ein einheitliches Metadatenvokabular für die semantische Anreicherung von Inhalten sowie ein Paketformat für die Auslieferung. Siehe auch https://de.wikipedia.org/wiki/IiRDS.

Informationsarchitektur

Definiert die Struktur von Inhalten und Metadaten für Technische Dokumentation sowie Regeln für die Modularisierung und Wiederverwendung von Inhalten und Dokumentationsvarianten. Die Informationsarchitektur bildet die Grundlage die Strukturierung und Standardisierung von Technischer Dokumentation.

Inkrement

Bestandteil eines Projekts, das nach Vorgehensmodell Scrum gesteuert wird. Die Anforderungen und Planungen für ein Projekt werden nicht auf einmal und im Ganzen festgelegt, sondern in kleinere Bestandteile zerlegt, die in so genannten Sprints, kurzen Entwicklungszeiträumen, abgearbeitet werden.

Integriertes Lernen

Lernform, die traditionelle Präsenzveranstaltungen und moderne Lernformen wie E-Learning miteinander verknüpft. Das Konzept verbindet die Effektivität und Flexibilität von elektronischen Lernformen mit den sozialen Aspekten der persönlichen Kommunikation sowie gegebenenfalls dem praktischen Erlernen von Tätigkeiten.

Intelligente Informationen

Strukturierte, formatneutrale und mit Metadaten angereicherte Informationen, z.B. Inhalte der Technischen Dokumentation. Bestehen aus Inhaltsmodulen, die zur Nutzung durch verschiedene Zielgruppen und Anwendungen geeignet sind.

Intent

Bezeichnet die Absicht, den ein:e Nutzer:in in der Konversation mit einem Chatbot verfolgt. Der Intent ist ein Schlüsselelement bei der Verarbeitung natürlicher Sprache, da er dem Chatbot ermöglicht, die Anforderungen des/der Nutzer:in zu erkennen und angemessen auf Eingaben zu reagieren.

Intents

Fassen zusammen, was Nutzer:innen mit einem Chatbot erreichen möchten, welche Absicht sie mit einer Frage verfolgen. Dabei werden im Voraus relevante Nutzerabsichten (Intents) definiert. Dies geschieht durch das Hinterlegen von möglichen Nutzereingaben und einer dazugehörigen Antwort. Anfragen der Nutzer werden anhand der Nutzeräußerung einem oder mehreren der bereits definierten Intents zugeordnet (Intent Matching). Quelle: https://botfriends.de/en/blog/botwiki/intents/.

INVEST (Checkliste)

Akronym für eine Checkliste von Kriterien, mit der als User Stories formulierte Anforderungen bewertet und verbessert werden können. I(ndependent). N(egotiable). V(aluable). E(stimatable). S(mall). T(estable).

IRI

Internationalized Resource Identifier. Internationalisierte Form der Uniform Resource Identifier (URI), definiert in RFC 3987. IRIs identifizieren Ressourcen wie z. B. Metadaten im Internet und machen sie so auffindbar und nutzbar.

K

Kanban

Methode oder Planungssystem für die Steuerung von Prozessen. Ursprünglich in der Toyota Motor Corporation als flexibles Steuerungskonzept in der Produktion entwickelt. Mit Kanban werden parallel stattfindende Arbeiten reduziert, kürzere Durchlaufzeiten erreicht und Probleme und Engpässe schnell erkannt.

Knowledge-Graph

Ein Knowledge Graph (deutsch: Wissensgraph) ist eine strukturierte Darstellung von Wissen, die Informationen in Form von Entitäten (Objekten oder Konzepten) und ihren Beziehungen zueinander abbildet.

M

MediaWiki

Open-Source-Software für die Erstellung und Veröffentlichung von Wikis, z. B. Wikipedia. Kann um zahlreiche Komponenten, u. a. für semantische Wikis, erweitert werden.

Metadaten

Daten, die Informationen über Merkmale anderer Daten enthalten, aber nicht diese Daten selbst, z. B. Informationen über den/die Autor:in in einem Word-Dokument. Metadaten können für den Leser sichtbar oder unsichtbar sein.

Metadatenmodell

Enthält die Metadaten einer bestimmten Domäne oder Organisation. Die Metadaten werden Inhalten zugewiesen und unterstützen so das Content-Management und die spätere Nutzung der Inhalte in Portalen oder Chatbots.

O

Ontologie

Formalisierte Beschreibung einer Menge von Begriffen und den zwischen ihnen bestehenden Beziehungen in einem bestimmten Fachbereich. Ontologien werden genutzt, um Wissen zu repräsentieren und zwischen Softwareanwendungen auszutauschen.

OWL

Formalisierte Beschreibungssprache für die Erstellung und Verteilung von Ontologien sowie deren Verarbeitung durch Softwareanwendungen. OWL ist eine Spezifikation des W3C.

Oxygen

XML-Editor der Firma Syncro Soft. Die Software unterstützt Formate wie DITA, DocBook und andere Publikationsformen, die in der Technischen Dokumentation häufig verwendet werden.

P

Personas

Hypothetische Personen mit verschiedenen Eigenschaften und Verhaltensweisen, die verschiedene Gruppen von Benutzenden repräsentieren. Personas werden in der nutzungsorientierten Gestaltung verwendet. Das Persona-Konzept ist verbreitet in der Produkt- und Softwareentwicklung und macht es möglich, Dinge mehr aus Sicht der eigentlichen Nutzenden zu sehen.

PI-Mod

Öffentlich zugängliches und kostenfreies Informationsmodell, das eine XML-Struktur für modulare Anwender- und Service-Dokumentation bietet und eine flexible Zusammenstellung von Dokumenten unterstützt. PI-Mod wird vorwiegend im Maschinen- und Anlagenbau und damit zusammenhängenden Branchen genutzt und lässt sich leicht in Redaktionssysteme integrieren.

Programmer's Guide

Dokumentationsart in der Software-Entwicklung. Enthält konzeptionelle Informationen über das Produkt und die Architektur einer API oder eines Frameworks, Aufgabenbeschreibungen für die Programmierung (Rezepte) und Code-Beispiele.

Publikations-Pipeline

Abfolge von automatisierten Vorgängen und Skripten, die aus Inhalten in einem Quellformat (z.B. DITA, AsciiDoc) ein gewünschtes Zielformat generieren (z.B. HTML, PDF).

R

RDF

Resource Description Framework. Standardisierte Beschreibungssprache zur Formulierung logischer Aussagen über beliebige Dinge (Ressourcen). Diese Aussagen werden als sogenannte Tripel definiert, das heißt ein Subjekt und ein Objekt werden miteinander in Beziehung gesetzt. Beispiel: John [Subjekt] ist der Vater [Beziehung] von Mike [Objekt].

S

Scrum

Agiles Vorgehensmodell für die Software-Entwicklung, in dem ein komplexes Projekt in Inkrementen entwickelt wird. Scrum-Teams können Produkte in kürzeren Zyklen fertigstellen und Feedback schneller einholen und einarbeiten.

Self-Service-Lösung

Ermöglicht es Anwender:innen, selbstständig Informationen und Problemlösungen zu einem Produkt oder einer Dienstleistung zu finden und ggf. weitere Unterstützung anzufordern.

SPARQL

Simple Protocol and RDF Query Language. Abfragesprache für das semantische Web. SPARQL kann Dateien, die im RDF-Format gespeichert sind, durchsuchen, auslesen und sogar verändern.

Sprint

Entwicklungszyklus (Iteration) in einem Scrum-Projekt. Beginnt mit einem Planning Meeting, in dem die Ziele formuliert werden, und endet mit einer Retrospektive. Ein Sprint ist auf einen festen Zeitraum beschränkt, in der Regel 1 bis 4 Wochen.

Stakeholder

Person oder Gruppe, die ein Interesse an den unternehmerischen Tätigkeiten einer Organisation hat. Stakeholder können diese Tätigkeiten beeinflussen oder von ihnen beeinflusst werden.

T

Taxonomie

Verfahren, mit dem Objekte anhand ihrer Eigenschaften klassifiziert und eingeordnet werden.

Topic

Grundelement in DITA, mit dem Inhalte strukturiert werden. Jeder Topic beanwortet eine Frage zu einem bestimmten Thema und ergibt auch allein stehend Sinn. Die drei wichtigsten Topic-Typen in DITA sind Concept, Reference und Task.

Touchpoint

Anwendungen, die Produktinformationen, Technische Dokumentation und andere Informationen für Kund:innen eines Unternehmens bereitstellen. Beispiele sind Kundendienst-Chatbots, Webportale, aber auch Dokumente.

U

Umgedrehter Unterricht

Unterrichtsmethode des integrierten Lernens, bei der sich die Teilnehmenden die Schulungsinhalte außerhalb der Schulungseinrichtung erarbeiten. Die Lehrperson stellt dafür Videos, Tutorials oder Schulungsunterlagen online zur Verfügung. In einem Präsenztraining werden die Lerninhalte und Übungen anschließend angewendet, Inhalte diskutiert und Fragen geklärt.

UML

Unified Modeling Language. Standardisierte Modellierungssprache, die sich u. a. in der Softwareentwicklung durchgesetzt hat. Sie modelliert Strukturen, Architekturen, Verhaltensweisen und Prozesse und stellt diese grafisch in Diagrammen dar. UML definiert Bezeichner für wichtige Begriffe sowie mögliche Beziehungen zwischen diesen Begriffen.

URI

Uniform Resource Identifier. Identifikator für Ressourcen im Internet, z.B. Websites, Dateien oder Webservices.

Use Case

Anwendungsfall oder Anwendungsbeispiel, das beschreibt, wie ein:e Nutzer:in (Akteur:in) ein System verwendet, um eine Aufgabe zu erfüllen. In der Software-Entwicklung besteht ein Use Case aus mehreren Schritten, in denen die Interaktionen zwischen Akteur:in und System definiert werden und die zum Ziel führen.

User Story

Kurzer Beschreibungstext in der agilen Software-Entwicklung, um Anforderungen aus Sicht der anwendenden Personen zu definieren. In ein bis zwei einfachen Sätzen wird dargestellt, in welcher Rolle die Personen was benötigen, um welchen Nutzen zu erzielen.

Utterance

Eine einzelne Äußerung einer Person, die diese an den Chatbot sendet und aus der der Chatbot einen Intent ableitet. “Mein Handy ist kaputt”, “Mein Handy funktioniert nicht mehr” oder “Wieso geht mein Handy nicht” sind Utterances für den Intent “kaputtes Handy”.

Utterances

Formulierungen der Nutzer:innen, aus denen anhand von Schlüsselworterkennung der Intent abgeleitet wird. “Mein Handy ist kaputt”, “Mein Handy funktioniert nicht mehr” oder “Wieso geht mein Handy nicht” sind beispielhaft Utterances für den Intent “kaputtes Handy”.

UX-Writing

Bezieht sich auf das Schreiben klarer, benutzerfreundlicher und konsistenter Texte in digitalen Produkten, um die Erfahrung der Benutzer:innen zu verbessern.

V

Variantenmanagement

Verwaltungsprinzip in der technischen Dokumentation. In einer Quelle werden die Dokumentationsmodule für verschiedene Varianten und Verwendungszwecke eines Produkts verwaltet. Damit kann eine Dokumentation zielgruppengerecht und kostengünstiger erstellt und gepflegt werden.

Verwaltungsschale

Engl.: Asset Administration Shell (AAS). Umsetzung des digitalen Zwillings für die Industrie 4.0. Eine Verwaltungsschale bildet einen Gegenstand (Asset) in der Industrie 4.0-Kommunikation ab, erlaubt den kontrollierten Zugriff auf alle Informationen des Gegenstands und bildet dessen Lebenszyklus ab.

W

W3C

World Wide Web Consortium. Internationale Community, die freie Webstandards wie Protokolle und Richtlinien definiert.

Wasserfallmodell

Lineares Vorgehensmodell im Projektmanagement. Die Entwicklungsaufgaben werden in aufeinanderfolgende Projektphasen unterteilt, wobei im Gegensatz zu iterativen Modellen jede Phase nur einmal durchlaufen wird. Die Ergebnisse der vorherigen Phase bilden die Grundlage für die Aufgaben in der nachfolgenden Phase.

Wiki

Web-basiertes System, in dem Wissen gemeinschaftlich gesammelt, dokumentiert und geändert wird.

X

XML

Extensible Markup Language. Erweiterbare Auszeichnungssprache, mit der komplexe Datenstrukturen in einem Format dargestellt werden, das sowohl für Menschen als auch für Maschinen lesbar ist. XML kann plattformunabhängig zwischen Systemen ausgetauscht werden.

XML-Schema

Sprache zur Definition von Strukturen und Regeln für XML-Dokumente. Im Unterschied zu DTDs wird die Struktur selbst in Form eines XML-Dokuments beschrieben.

XPath

Abfragesprache, die Teile eines XML-Dokuments adressiert und abfragt. XPath wurde u. a. für die Verwendung in XSLT entworfen.

XSL

Extensible Stylesheet Language. Oberbegriff für eine Sprachfamilie, bestehend aus XSL-FO, XSLT und XPath. XSL definiert die Transformation und Ausgabe von XML-Dokumenten.

XSL-FO

Extensible Stylesheet Language Formatting Objects. Auszeichnungsprache und Teil der XSL-Sprachfamilie. XSL-FO beschreibt, wie Text und Elemente auf einer Seite angeordnet werden. Wird meistens genutzt, um PDF-Dokumente aus XML-Quellen zu erzeugen.

XSLT

Extensible Stylesheet Language Transformations. Tranformationskomponente von XSL, mit der XML-Dokumente in andere Formate, wie HTML, oder andere XML-Definitionen, umgewandelt werden.

XWiki

Quelloffenes, erweiterbares semantisches Wiki.