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)

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 -1 - (von 30)

Informations­recherche

Tätigkeit, die darauf gerichtet ist, Informationsquellen zu suchen, um diese erschließen zu können.

Doku -2 - (von 30)

Fehlersuchtabelle

Eine Tabelle, die typische Fehler, deren mögliche Ursachen und geeignete Maßnahmen zur Fehlerbehebung auflistet. Sie dient als Hilfsmittel zur schnellen Problemlösung.

Vorzugsweise geordnet nach Auftrittswahrscheinlichkeit (häufige Fehler zuerst).

Doku -3 - (von 30)

Konstruktions­unterlagen

Dokumente, die die vorgesehene Konstruktion so festlegen, dass ein Dritter sie bauen kann oder spezifische Informationen entnehmen kann.

Technische Details zur Konstruktion, wie Zeichnungen, Schaltpläne und Stücklisten.

Die Konstruktions­unterlagen müssen aktuell sein.

Doku -4 - (von 30)

Funktion

Das Wort "Funktion" ist im Deutschen mehrdeutig.

  • Funktion eines Bauteils = Zweck, dem das Bauteil dient - Funktion, als Teil einer Software, die eine bestimmte Aufgabe ausführt
  • Funktion als Vorgehensweise (ich weiss nicht, wie das Produkt funktioniert)
  • Funktion als Funktionsweise (z.B. des 4-Taktmotors).

Doku -5 - (von 30)

Sicherheits­dokumentation

Enthält Informationen zu den Sicherheitsprotokollen, Verschlüsselungsmethoden, Authentifizierungsverfahren und anderen Sicherheitsmaßnahmen, die in einem System oder Produkt vorhanden sind.

Doku -6 - (von 30)

Wartungsplan

Ein Informationsprodukt oder Teil einer Anleitung, die regelmäßige Wartungsarbeiten sowie deren Intervalle und Verantwortlichkeiten beschreibt, um den Betrieb und die Langlebigkeit eines Geräts sicherzustellen.

Meist nach Wartungsintervallen geordnet, z.B.: täglich, monatlich, alle 100 Std.

Doku -7 - (von 30)

Leserlichkeit

Eigenschaft der eindeutigen Erkennbarkeit eines einzelnen Zeichens oder Symbols, das ohne Kontext dargestellt wird.

Doku -8 - (von 30)

Sicherheitshinweis

Sicherheitsbezogene Informationen, die nach einem sinnvoll organisierten System in einem Dokument oder Abschnitt eines Dokuments gesammelt oder gruppiert sind, um Sicherheitsmaßnahmen zu erklären, Sicherheitsbewusstsein zu erhöhen und eine Grundlage zur sicherheitsbezogenen Schulung der Personen zu schaffen.

Doku -9 - (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 -10 - (von 30)

Glossar

Eine Liste von Begriffen mit Definitionen, die sich in der Regel am Ende eines Dokuments befindet.

  • Alphabetisch sortiert, enthält Fachbegriffe, Fremdwörter und Abkürzungen mit Erklärungen.
  • Kann mit Informationen wie Herkunft, Merkmalen oder Nutzen ergänzt werden.

Doku -11 - (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 -12 - (von 30)

Handlungs­orientiert

Eine handlungsorientierte Dokumentation konzentriert sich auf die Beschreibung von Arbeitsschritten und Verfahren, die ein Benutzer durchführen muss, um ein bestimmtes Ziel zu erreichen.

Anstatt technische Details und Spezifikationen zu betonen, wird hier der praktische Ablauf von Tätigkeiten, wie etwa die Bedienung oder Wartung eines Produkts, detailliert beschrieben.

Doku -13 - (von 30)

Modularisierung

Zerteilen der Gesamtdokumentation in zweckmäßige unabhängige Informationseinheiten, die zentral erstellt und geändert werden, und unverändert in einer Publikation (auch mehrfach) verwendet werden können.

Doku -14 - (von 30)

Tabellen­verzeichnis

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

Doku -15 - (von 30)

Konsistenz

Gleichförmigkeit in Wortwahl, Struktur und Darstellung.

In allen Informationsprodukten ist Konsistenz gefordert, damit der Nutzer sich an die Darstellung gewöhnt und immer besser zurecht findet.

Doku -16 - (von 30)

Identifikation

Information, die den Nutzer befähigt, das Informationsprodukt dem Produkt zuzuordnen.

  • Produktname
  • Versionsnummer
  • ggf. Seriennummer

Doku -17 - (von 30)

Informations­modell

Darstellung von Konzepten, Beziehungen und Regeln für eine Gesamtheit an Informationen.

Doku -18 - (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 -19 - (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 -20 - (von 30)

Schritt

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

Doku -21 - (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 
  • digitale Abbildung

Doku -22 - (von 30)

Lieferumfang

Gesamtheit der vom Hersteller eines Produkt bereitgestellten Produktbestandteile und Dokumente.

  • Meist als Bild des Produkts mit allen Teilen
  • Tabelle der Teile, mit Bezug zum Bild.

Dient dem Nutzer zur Prüfung auf Vollständigkeit.

Doku -23 - (von 30)

Advance Organizer

Text am Anfang eines Kapitels, der den Leser auf den Inhalt einstimmt.

  • Meist als Vorstrukturierung des Inhalts, Einstimmung und Motivation.
  • Oft grafisch hervorgehoben.

Doku -24 - (von 30)

Style Guide

Eine Reihe von Standards für das Schreiben und Formatieren von Dokumenten, die eine einheitliche Sprache, einen einheitlichen Ton und eine einheitliche Darstellung gewährleisten.

Doku -25 - (von 30)

Gamification

Einbinden von spielerischen Ansätzen und Reizen, um die Effizienz und Effektivität von Tätigkeiten zu verbessern, um Zusammenarbeit zu stimulieren und Innovationen anzuregen.

Doku -26 - (von 30)

Anleitung zur Anleitung

Kapitel in einer Anleitung, dass die Systematik der Ordnung erklärt oder Tipps zur Benutzung der Anleitung gibt.

Normalerweise sollte dieses Kapitel nicht notwendig sein, die Ordnung sollte selbsterklärend sein.

Bei besonderen Systematiken oder neuen Anordnungen kann das Kapitel sinnvoll sein.

Doku -27 - (von 30)

Sicherheits- und Warnhinweise

Informationen in einer Nutzungsinformation, die der Sicherheit des Nutzers bei der Verwednung und der Erreichung eines sicheren Ergebnisses dienen.

  • Sicherheitshinweise: Hinweise zu allgemeinen Gefahren und deren Vermeidung beim Umgang mit dem Produkt am Anfang der Nutzungsinformation
  • Warnhinweise: Warnung vor Gefahren bei einer Handlung

Doku -28 - (von 30)

System­dokumentation

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

Doku -29 - (von 30)

Anwender / Nutzer

Person, die ein Produkt benutzt, bedient und Nutzen daraus zieht.

Doku -30 - (von 30)