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
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.
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
Content-Lieferkette
Content-Strategie
Continuous-Integration
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
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.
G
Generative KI
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
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
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
Intent
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
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
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
MoSCoW
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
Oxygen
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.
Product Information Management System (PIM)
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
R
RDF
Retrieval Augmented Generation
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
SPARQL
Sprint
Stakeholder
T
Taxonomie
Topic
Touchpoint
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
Utterances
UX-Writing
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
W
W3C
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
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.