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)

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.

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

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

Dokuelement -4 - (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 -5 - (von 30)

Funktionsbeschreibung

Bei Software nach Juhl:

Erklärung einer Softwarefunktion als Ganzes und in Teilen, um den Nutzer per Verständnis handlungsfähig zu machen.

Dabei werden der Zweck der Gesamtfunktion erklärt und Handlungsmöglichkeiten aufgezeigt und illustriert.

Dokuelement -6 - (von 30)

Handlungsziel

Beschreibt das erwartete Ergebnis und erklärt ggf. wann und warum diese Handlung ausgeführt werden soll.

  • steht meistens am Anfang einer Handlungsanweisung
  • Wiederholt die Überschrift und führt sie weiter aus.

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

Impressum

Kapitel meist am Anfang eines Informationsprodukts, das Verwaltungsinformationen zum Dokument enthält.

  • Stand: Verion und Datum
  • Herstelleradresse
  • Veränderungshinweis
  • Copyright
  • Vervielfältigungsverbot

Dokuelement -9 - (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 -10 - (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 -11 - (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 -12 - (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 -13 - (von 30)

Technische Daten

Meist tabellarisch zusammengestellte der technischen Parameter.

Technische Daten unterstützen den Nutzer bei der Auswahl und Prüfung der Leistungsfähigkeit.

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

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

Schritt-für-Schritt-Anleitung

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

Dokuelement -17 - (von 30)

Lesehinweis

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

Dokuelement -18 - (von 30)

Sicherheitskapitel

Kapitel am Anfang des Informationsproduktes mit Hinweisen zur Sicherheit

  • Warnung vor allgemeinen Gefahren
  • Muss vom Nutzer vor der Nutzung gelesen werden und behalten werden
  • Aufbau eines Sicherheitsbewusstseins
  • Richtiges Verhalten - Begründung
  • Warnung - Richtiges Verhalten

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)

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

Tabellen­verzeichnis

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

Dokuelement -22 - (von 30)

Topic

In sich abgeschlossener Inhaltsblock, der durch Überschrift und Inhalt bestimmt wird, eine Kernaussage mit den vollständigen Informationen zu einem Thema enthält und ohne weiteren Kontext gelesen und verstanden werden kann.

Kriterien nach Mark Baker #EPPO:

  • self contained
  • Specific + Limited Purpose
  • Conform to a Type
  • Establish their context
  • Assume the Reader is Qualified
  • Stay on one Level
  • Link Richly

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

Dokuelement -24 - (von 30)

Aufbau und Funktion

Kapitel, dass das Produkt aus technischer Sicht beschreibt.

  • Funktionseinheiten
  • Bedienelemente
  • bediente Teile

Dokuelement -25 - (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 -26 - (von 30)

Identifikation

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

  • Produktname
  • Versionsnummer
  • ggf. Seriennummer

Dokuelement -27 - (von 30)

Makroskopische Betrachtung

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

Dokuelement -28 - (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 -29 - (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 -30 - (von 30)