Terms-Karussell
nur Test!

Bereich: Doku (30)

Terms der Technischen Kommunikation

  • max 30 von 30 Begriffen
  • zufällige Auswahl
  • zum Durchblättern


unfertig
Stand: 18.01.2025
Quellen: tekom terms und D. Juhl

Doku -1 - (von 30)

Redaktionsleitfaden

Sammlung verbindlicher Vorgaben innerhalb eines Unternehmens für das Erstellen von Technischer Dokumentation.

Doku -1 - (von 30)

Garantie­erklärung

Äußerung des Verkäufers, des Herstellers oder eines Dritten, mit der dem Käufer eine Garantie eingeräumt wird.

Doku -2 - (von 30)

Informations­beschaffung

Tätigkeit, die darauf gerichtet ist, Informationsquellen zu erschließen und auszuwerten, z.B.

  • Sichtung bestehender Unterlagen
  • Recherche
  • Interviews

Doku -3 - (von 30)

Handlungsanweisung

Information zur schrittweisen Ausführung einer Tätigkeit.

Von Juhl geprägter Begriff, der die Schritt-für-Schritt-Anleitung strukturiert und mit weiteren Elementen anreichert.

Elemente:

  • Überschrift
  • Ziel der Handlung
  • ggf. Voraussetzungen
  • Schritt für Schritt
  • Handlungsergebnis
  • Ausblick

Doku -4 - (von 30)

Hydraulikplan

Grafische Darstellung der Strömungen von Flüssigkeiten für Steuer-, Regel-, Antriebs- und Bremsvorrichtungen von Fahrzeugen, Flugzeugen oder Geräten, deren Kräfte mithilfe des Drucks einer Flüssigkeit erzeugt oder übertragen werden.

Doku -5 - (von 30)

Lesbarkeit

Kriterium für die Textverständlichkeit auf Grund der sprachlichen Gestaltung.

Doku -6 - (von 30)

Schritt-für-Schritt-Anleitung

Text, der zur Erreichung eines Zieles konkrete Vorgaben für jeden einzelnen Schritt macht.

Doku -7 - (von 30)

Adressen

Kontaktinformationen von relevanten Stellen, wie z. B. Hersteller, Lieferanten, Servicestellen oder autorisierte Fachhändler. Diese Adressen werden vom Nutzer oft für Anfragen oder den Kauf von Ersatzteilen benötigt.

Häufig am Ende einer Anleitung angeordnet.

Doku -8 - (von 30)

System­dokumentation

Dokumentation, die erklärt, wie ein System funktioniert, einschließlich seiner Komponenten, Konfiguration und Verwendung.

Doku -9 - (von 30)

Short Referenz

Übersichtliche Zusammenstellung von Referenzinformationen (z.B. Befehle, Parameter …), wobei jedes Element nur in der obersten Informationsebene dargestellt ist.

Doku -10 - (von 30)

Informations­entwicklung

Prozess der Entwicklung, Strukturierung und Präsentation von Informationen.

Doku -11 - (von 30)

Schaltplan

Grafische Darstellung der Schaltung einer elektrischen Einrichtung, eines elektrischen Geräts mithilfe von Schaltzeichen.

Schaltpläne eignen sich in der TD ggf. auch als Information zur Reparatur.

Doku -12 - (von 30)

Funktionsweise 1

Informationen welche Komponenten und Abläufe verwendet werden, um technisches Ziel zu erreichen.

Meistens mit Bild der Funktionseinheit und einer schrittweisen Erklärung mit gutem Bild-Textbezug.

Didaktisch kann es sinnvoll sein, zuerst die Normal-Funktionsweise zu beschreiben und andere Fälle anschließend zu erklären.

Beispiel: Funktionsweise des 4-Takt-Motors

Doku -13 - (von 30)

Datenblatt

Ein Dokument, das detaillierte technische Spezifikationen zu einem Produkt oder einer Komponente enthält und häufig in der Technik- und Hardwaredokumentation verwendet wird.

Doku -14 - (von 30)

Lieferanten­dokumentation

Dokumentations-Dokumente zu Einzelteilen einer Anlage, die ein Anlagenhersteller zu seiner, von ihm erstellten Anlagendokumentation mitliefert.

Meistens wird diese Lieferanten­dokumentation als Original des Lieferanten unbearbeitet beigefügt und dient dem Betreiber als weitere Quelle bei technischen Fragen.

Probleme:

  • unterschiedliche Terminologie
  • Copyright des Lieferanten

Doku -15 - (von 30)

Dokumentations­struktur

Strukturierung aller Dokumente.

Regelt die Aufteilung, Anordnung und Gestaltung von Dokumentationsinhalten. Ermöglicht eine logische und benutzerfreundliche Navigation.

Doku -16 - (von 30)

mobile Technische Dokumentation

Technische Dokumentation, die technisch und von der Darstellung so ausgeführt ist, das sie auf mobilen Endgeräten benutzt werden kann.

  • Smartphones, Tablet-PCs und tragbaren Displays aller Art

Häufig ist die TD responsiv ausgeführt, so dass sie auf unterschiedlichen Devices gut dargestellt wird.

Teilweise wird das Mobile-First Prinzip angewendet:
Dabei ist die Darstellung auf Smartphones optimiert aber andere Devices möglich (ggf. nicht optimal).

Doku -17 - (von 30)

Schritt

Auszuführende Handlung, die der Nutzer als Einzelnes verstehen und handeln kann.

Doku -18 - (von 30)

Tabellen­verzeichnis

(automatisch erzeugte) Liste aller in der Dokumentation eingebundenen tabellarischen Objekte.

Doku -19 - (von 30)

Informations­architektur

Strukturelle und konzeptionelle Grundlage für die Ausrichtung, Aufteilung und Anordnung von Informationen.

Meist in mehreren Ebenen:

  • Aufteilung in Informationsprodukte
  • Gliederung
  • Aufteilung in Topics
  • Strukturierung der Topics
  • Frontend und Navigation 

Doku -20 - (von 30)

Veränderungshinweis

Text, der darauf hinweist, dass das Produkt möglicherweise in Teilen verändert / verbessert wurde und die Anleitung sinngemäß gilt, z.B.:

Technische Änderungen vorbehalten

Doku -21 - (von 30)

Gerätebeschreibung

Beschreibt Aufbau und Funktion eines Geräts meist mit:

  • Abbildung des Produkts
  • Name und Funktion der Teile
  • Erklärung der Zusammenhänge

Dient einem Nutzer als erste Information und Kennenlernen der verwendeten Bezeichnungen von Bedienelementen und bedienten Produktteilen.

Doku -22 - (von 30)

Abbildung der Handlung

Möglichkeit mit einer Abbildung zu einer Handlung anzuleiten, z.B.:

  • ein Bild mit Nummern und grafischer Gestaltung der Arbeitsschritte
  • mehrere Bilder mit jeweils einem Arbeitsschritt

Doku -23 - (von 30)

Orientierungselemente

Strukturelle Elemente in einer Dokumentation, die den Lesern helfen, sich schnell zurechtzufinden.

Dazu gehören bei Print:

  • Inhaltsverzeichnis, Überschriften, lebende Kolumnentitel

Bei Digital:

  • Inhaltsverzeichnis (meist in Explorertechnik), Kapitelpfad

Doku -24 - (von 30)

Sicherheits­vorschriften

Oberbegriff: Rechtliche Anforderungen

Merkmale:

  • Beinhalten Warnhinweise und Maßnahmen zur Unfallvermeidung.
  • Wichtiger Bestandteil von technischen Dokumentationen.

Beispiele: Maschinenrichtlinie, spezifische Warnungen für Messgeräte​.

Doku -25 - (von 30)

Variantenmanagement

Methode zur spezifischen bzw. individualisierten Anpassung von Informationen zu einem Produkt/einer Produktserie.

Doku -26 - (von 30)

Stichwort­verzeichnis

Nach einheitlichen Kriterien systematisch erstellte, meist alphabetisch angeordnete Liste von Themen, Schlagwörtern, Begriffen und Dokumenteigenschaften, die dem Leser einen weiteren Zugang zum Inhalt bietet.

Doku -27 - (von 30)

Kontext­sensitivität

Methode, um aus einer Nutzung direkt zur passenden Information zu gelangen.

Oder aus Programmierersicht:
Einbau eines Links in die UI zum passenden Topic.
Hierfür müssen Programmierer und TR kooperieren.

Möglichkeit, Informationen situations- und zielgruppengerecht zu filtern und damit genau passend zum aktuellen Informationsbedarf des Anwenders auszugeben.

Doku -28 - (von 30)

Tätigkeits­beschreibung

Methoden, die geeignete sind, einem Nutzer eine Tätigkeit so zu vermitteln, dass er sie ohne fremde Hilfe ausführen kann, z.B.:

  • Schritt-für-Schritt-Anleitung
  • Handlungsanweisung
  • Regeln zur Handlung
  • Erklärung der Bedienelemente (Wirkung, Möglichkeiten) Abbildungen

Doku -29 - (von 30)

Makroskopische Betrachtung

Überblick über die Funktion eines Systems oder Geräts, ohne ins Detail zu gehen.

Doku -30 - (von 30)