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)

Kurzanleitung

Eine Kurzanleitung ist eine zusätzliche Anleitung, die die Schritte jeder Handlung gekürzt darstellt, meistens als Bild und Kurztext.

Sie soll dem eingearbeiteten Nutzer als Gedächtnisstütze bei der Ausführung von Handlungen dienen.

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

Schritt-für-Schritt-Anleitung

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

Doku -3 - (von 30)

Microcopy

Alle kurzen verbalen Hinweise und Beschriftungen, die die

Bedienung eines User Interfaces erleichtern oder erst ermöglichen.

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)

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

Sicherheitsbezogene Information

Informationen, die vor allem der Sicherheit des Nutzers vor Verletzungen dienen.

Doku -7 - (von 30)

Bedienungsanleitung

eine vom Hersteller mitgelieferte Information zur richtigen Verwendung eines Produkts.

Doku -8 - (von 30)

Literatur­verzeichnis

Liste der verwendeten oder weiterführenden Informationsquellen, meist als Buch in der Form:

  • Autor
  • Titel
  • Erscheinungsjahr
  • Verlag

XXX prüfen XXX

Doku -9 - (von 30)

Use Case der TD (Juhl)

Anlässe bei denen ein Nutzer Informationen benötigt und ggf. die Nutzungsinformation zur Hand nimmt, z.B.:

  • Auswahl
  • erste Benutzung
  • Einarbeitung
  • Normalbenutzung
  • konkrete Frage
  • weiter lernen
  • alles lesen

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

Leserlichkeit

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

Doku -12 - (von 30)

gliederungs­basierte Modularisierung

Modularisierungstyp, bei dem die bestehenden Kapitel- und Unterstrukturen als Modulgrenzen beibehalten werden.

Doku -13 - (von 30)

Überschrift

Herausgehobener Absatz am Anfang eines Kapitels.

  • meist größer formatiert
  • klare Aussage zum Kerninhalt des Kapitels
  • als Orientierung für den Nutzer, ob das Kapitel für seine momentane Frage relevant ist

Doku -14 - (von 30)

Produkthandbuch

Synonym zu Nutzungsinformation.

Ein umfassender Leitfaden, der die Einrichtung, Verwendung und Fehlerbehebung eines Produkts abdeckt.

Doku -15 - (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 -16 - (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 -17 - (von 30)

Leistungs­beschreibung

Beschreibt Zweck und Nutzen eines Geräts.

Umfasst:

  • Produktkategorie
  • Normalleistung
  • Besonderheiten
  • technische Details
  • Erweiterungsmöglichkeiten.

Definiert den bestimmungsgemäßen Gebrauch.

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

Software­funktions­beschreibung

Geräteorientierte Darstellung, die eine Softwarefunktion als Ganzes erklärt (im Gegensatz zur handlungsorientierten Darstellung).

Beschreibt eine Softwarefunktionen als Angebot einen Zweck zu erfüllen und zeigt Varianten (Handlungsmöglichkeiten) auf.

Doku -20 - (von 30)

Informations­entwicklung

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

Doku -21 - (von 30)

Makroskopische Betrachtung

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

Doku -22 - (von 30)

Short Referenz

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

Doku -23 - (von 30)

Gesamtdokumentation

Doku -24 - (von 30)

Dokumenten­management

Datenbankgestütztes Verwalten von elektronischen oder elektronisch erfassten Dokumenten, das z. B. das Finden über Metadaten, das Verwalten von Textmodulen und deren Versionen und Varianten, Archivierung, Freigabeprozesse und Erzeugen von Ausgabeinstanzen Single Source Publishing) beinhaltet.

Doku -25 - (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 -26 - (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 -27 - (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 -28 - (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 -29 - (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 -30 - (von 30)