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)

Lesbarkeit

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

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

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

Informations­recherche

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

Doku -6 - (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 -7 - (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.

Doku -8 - (von 30)

Quickstart

Quickstart ist eine Anleitung, die den Nutzer in die Lage versetzen soll, schnell und ohne viel lernen zu müssen, das Produkt in Betrieb zu nehmen und in den Grundfunktionen zu benutzen.

Sie wird vor allem für Produkte angeboten, die ausser der Grundfunktion eine Vielzahl von weiteren Möglichkeiten anbieten, z.B. Spiegelreflexkamera.

Doku -9 - (von 30)

Schritt

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

Doku -10 - (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

Doku -11 - (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 -12 - (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 -13 - (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 -14 - (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 -15 - (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

Doku -16 - (von 30)

Allgemeine Technische Dokumentation

Sammlung von technischen Informationen zu einem Produkt. Meist in der Form, wie sie bei der Entwicklung entstehen, mit dem Zweck alle Informationen für jedweden Zweck festzuhalten.

Doku -17 - (von 30)

Technische Dokumentation

Gesamtheit aller notwendigen und zweckdienlichen Informationen über ein Produkt und seine Verwendung, die in strukturierter Form – sei es auf Papier oder als elektronische Medien – festgehalten sind.

Doku -18 - (von 30)

Sicherheitsbezogene Information

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

Doku -19 - (von 30)

Minimalismus

Prinzip, dass Nutzungsinformationen kritische Informationen und die kleinstmögliche Menge anderer erforderlicher Informationen enthalten, um vollständig zu sein.

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

Lesehinweis

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

Doku -22 - (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

Doku -23 - (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 -24 - (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 -25 - (von 30)

Microcopy

Alle kurzen verbalen Hinweise und Beschriftungen, die die

Bedienung eines User Interfaces erleichtern oder erst ermöglichen.

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

Informationskonzept

Im Informationskonzept wird festgelegt, welche Informationen in welchem Informationsprodukt in welcher Informationsstruktur und in welcher Tiefe für welche Zielgruppe dargeboten werden.

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