Terms-Karussell
nur Test!

Bereich: Dokuelement (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

Dokuelement -1 - (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

Dokuelement -1 - (von 30)

Bedienelemente

Elemente oder Schnittstellen, die von Benutzern bedient werden können, um eine Maschine, ein Gerät oder ein System zu steuern. Beispiele sind Tasten, Schalter, Drehknöpfe oder Touchscreens.

Dokuelement -2 - (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

Dokuelement -3 - (von 30)

Pfad / Inhaltspfad

Ein visueller oder textbasierter Hinweis, der zeigt, in welchem Teil der Dokumentation sich der Leser gerade befindet.

  • Beispiel: Kapitel- oder Abschnittsüberschriften.
  • Beispiel: Bedienung > Normalbetrieb > Ein-Auschalten

Dokuelement -4 - (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.

Dokuelement -5 - (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.

Dokuelement -6 - (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

Dokuelement -7 - (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.

Dokuelement -8 - (von 30)

Leistungs­beschreibung

Beschreibt Zweck und Nutzen eines Geräts.

Umfasst:

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

Definiert den bestimmungsgemäßen Gebrauch.

Dokuelement -9 - (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.

Dokuelement -10 - (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.

Dokuelement -11 - (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).

Dokuelement -12 - (von 30)

Makroskopische Betrachtung

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

Dokuelement -13 - (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.

Dokuelement -14 - (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

Dokuelement -15 - (von 30)

Modul

Ein Modul ist eine Informationseinheit (meist Text und Bild), die bei Bedarf immer wieder und unverändert eingesetzt werden kann.

Module sind besonders bei der Arbeit mit Redaktionssystemen wichtig.

Module werden zentral erstellt und bearbeitet und unverändert in unterschiedlichen Zusammenhängen verwendet (Single Source Publishing).

Dokuelement -16 - (von 30)

Anhang

Ergänzungen zum Haupttext am Ende eines Dokuments, die

Anmerkungen, statistische Tabellen oder andere Informationen enthalten

Dokuelement -17 - (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.

Dokuelement -18 - (von 30)

Lesehinweis

Text, häufig auf dem Titelblatt, das den Nutzer auffordert, die Anleitung zu lesen.

Dokuelement -19 - (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.

Dokuelement -20 - (von 30)

Technische Unterlagen

Informationen, die während der Konstruktion eines Geräts erstellt werden.

Dazu gehören Konstruktionszeichnungen, Schaltpläne, Ersatzteillisten, und Serviceunterlagen.

Diese sind für Fachleute bestimmt und enthalten keine Anweisungen für Endbenutzer.

Dokuelement -21 - (von 30)

Identifikation

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

  • Produktname
  • Versionsnummer
  • ggf. Seriennummer

Dokuelement -22 - (von 30)

Schritt-für-Schritt-Anleitung

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

Dokuelement -23 - (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

Dokuelement -24 - (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

Dokuelement -25 - (von 30)

Tabellen­verzeichnis

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

Dokuelement -26 - (von 30)

Aufbau und Funktion

Kapitel, dass das Produkt aus technischer Sicht beschreibt.

  • Funktionseinheiten
  • Bedienelemente
  • bediente Teile

Dokuelement -27 - (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.

Dokuelement -28 - (von 30)

Garantie

Eine durch den Verkäufer oder Hersteller freiwillig eingeräumte Einstandspflicht dafür, dass innerhalb eines bestimmten Zeitraumes kein Mangel an einer Sache auftritt.

Dokuelement -29 - (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

Dokuelement -30 - (von 30)