4 - D3

4 - D3

4 - D3


R. L.
Diese Lernkarten bieten eine grundlegende Einführung in die Erstellung und Optimierung technischer Dokumente. Sie decken Themen wie Terminologie, Strukturierung, und Qualitätskriterien ab, wobei der Fokus auf der Klarheit und Verständlichkeit von Informationen liegt. Besonders nützlich sind sie für Autoren und Redakteure, die technische Inhalte für verschiedene Zielgruppen aufbereiten müssen, um Missverständnisse zu vermeiden und die Effizienz der Kommunikation zu steigern.
Karten
36
Lernende
1
Sprache
Deutsch
Kategorie
Scherzfragen
Stufe
Grundschule
Erstellt / Aktualisiert
17.06.2014 / 22.06.2014

Lernkarten

*** Experten-Laien-Kommunikation und Dokumentation ***

Bedeutung der Experten-Laien-Kommunikation

Quantitativ:
Kenntnis von der Existenz eines bestimmten wissenschaftlichen Wissens
Übernahme wissenschaftlicher Begriffe in die Umgangssprache
Übernahme von wissenschaftlichen (Teil-)Modellen
Qualitativ:
Popularisierung (durch Fachzeitschriften, Medien etc.)
Didaktisierung (für schulische oder berufliche Qualifikation)
Vulgarisierung (Teil des Alltagsdiskurses)

Wissensprobleme

Probleme
Zugang zum Wissen für Experten vs. für Laien
unverständliches Wissen der Experten
Metawissen: Existenz, Struktur, Inhalt und Implikationen eines Wissensbestandes
aktuelle Tendenzen
Ökonomisierung des Wissensbegriffs
Data smog und „Vertrauensgau“
Transaktionskosten des Wissens
ungleiche Wissensverteilung: Gefahr der Expertokratie

Vermittlungsstrategien und -techniken

Strategien der Vermittlung
- Geschichten von Wissenschaft erzählen
- Personalisierung
- Geschichte der Erforschung eines Phänomens
- Betonung des Nutzens und der Wichtigkeit der Ergebnisse
- Bezug zum Alltag, handfeste Vergleiche, Metaphern
Techniken der Vermittlung
- Informationen weglassen, vereinfachen, zusammenfassen
- Inhalte erläutern, mit Hintergrundinformationen ergänzen
- Fachwörter definieren, umschreiben, weglassen
- Satz- und Textstrukturen journalistisch variieren

Fachartikel: IMRAD-Schema

Autor
Titel
Abstract

Introduction (I)
Methods (M)
Results (R)
And (A)
Discussion (D)

Anmerkungen
Literaturverzeichnis

Ziele der Dokumentation

In allen Phasen des Produktlebenszyklus sind dem Unternehmen aussagefähige Nachweise über die Produkte und deren Eigenschaften möglich.

Externen Nutzern werden angemessene und vollständige Benutzerinformationen zur Verfügung gestellt

Die Entscheidungsgrundlagen eines Projekts sind jederzeit abrufbar, indem alle während eines Projekts anfallenden Dokumente gestaltet, gekennzeichnet und archiviert sind.

Zielgruppen der Dokumentation

Entwickler - liest Arbeitsauftrag, Protokolle, Lastenheft,
Pflichtenheft, um…
Auftraggeber - liest Protokolle, Lastenheft, Pflichtenheft, um…
Abteilungsleiter, Geschäftsführer - liest Statusbericht, um…
Kunde - liest Pflichtenheft, um…
Nutzer - liest Fehlermeldung in der Betriebsanleitung, um…
Technischer Redaktor - liest Entwicklerdokumente, um…

Dokumentarten im Produktlebenszyklus

bild

Projektdokumentation - Fragen

– Wie wird dokumentiert?
– Was muss dokumentiert werden?
– Wann soll dokumentiert werden?
– Wie lange werden die Dokumente aufbewahrt?
– Wo werden die Dokumente aufbewahrt?
– Wie geschieht die Nachführung der Dokumente?

*** Methoden der Strukturierung und Visualisierung ***

Wozu Strukturierung?

Der Text ist
- leicht verständlich
- geeignet für den eiligen Leser
- geeignet für den selektiven Leser
- auf die wesentlichen Informationen konzentriert.
Wesentliche Informationen sind schnell zu finden.

Probleme

Probleme des Lesers
- Schlechter Aufbau
- Unübersichtlich
- Prioritäten nicht erkennbar
- Zu viel Information
- Uneinheitlich
Probleme des Verfassers
- Wo anfangen?
- Verschiedene Zielgruppen ansprechen
- Leserbedürfnisse kennen
- Änderungen bis zuletzt

Information Mapping

bild

Strukturieren anhand von Informationsprinzipien

bild

Der Block: Definition

Ein Block besteht aus:
- Einer Informationseinheit, die eine Aussage enthält, deren Inhalt für den Leser relevant ist.
- einem Titel, der klar die Funktion oder den Inhalt der
Information beschreibt.

Strukturieren anhand von Informationsarten

bild

Konzept für Bedienungsanleitung

Leistungsbeschreibung
Art und Nutzen des Geräts
Bestimmungsgemässer Gebrauch
Gerätebeschreibung
Aussehen, Identifikation
bedienrelevante Teile mit Benennung und Zweckangabe
Tätigkeitsbeschreibung

notwendige Handlungen, Vorgehen
Nutzungsmöglichkeiten
konkrete Handlungsanweisung
Funktionsweise (optional)
Beschreibung der Funktionsweise und der Prinzipien
Fehlervermeidung und -suche
Technische Unterlagen (optional)
Konstruktionsunterlagen: Konstruktionsunterlagen, Schaltpläne, Stücklisten usw.
Serviceunterlagen: Ersatzteillisten, Masszeichnungen, Prüfprotokolle, Messpunkte, Flowchart zur Fehlersuche usw.

Verschiedene Diagramme

folien 11-2

*** Schreibprozesse und Textoptimierung ***

Austausch über Inhalt und über Aufgaben/Rollen

bild

Kanäle der Kollaboration

Zeitversetzte Kommunikation
1. E-Mail
2. Kommentare abgeben
3. Änderungsvorschläge im Text
anbringen
4. Versionen verfolgen
Zeitgleiche Kommunikation
1. Sitzung
2. Audio-/Videokonferenz
3. Chat
4. White-Board
5. Integrated Groupware

Schreibprozess Leitlinien

- LL 1: Gemeinsames Verständnis der Ziele entwickeln
- LL 2: Detailpläne aufstellen
- LL 3: Fahrplan machen
- LL 4: Verantwortlichkeiten organisieren
- LL 5: Effiziente Sitzungen organisieren
- LL 6: Austausch fördern

Leitlinie 1: Gemeinsames Verständnis der Ziele

Möglichkeiten
- Teamleiter oder Teammitglied schlägt vor
- Verständnis der Ziele wird durch eine gemeinsame Diskussion erarbeitet
Prozess
- Aushandeln
- Einverständnis aller Beteiligten sicherstellen
- Strategien diskutieren
- Verabredungen protokollieren
- Getroffene Verabredungen ggf. an neue Erkenntnisse anpassen

Leitlinie 2: Detailpläne aufstellen

Storyboard entwickeln

Leitlinie 3: Fahrplan machen

- Genügend Zeit für Planung und Zieldiskussion einplanen
- Genügend Meilensteine einplanen
- Genügend Zeit für Überarbeitung und Korrektur einplanen

Leitlinie 4: Verantwortlichkeiten organisieren

Rollenbereiche im Team:
- Aufgabenorientierung
- Beziehungsorientierung

Leitlinie 5: Effiziente Sitzungen organisieren

- Agenda
- Diskussionen rechtzeitig abschliessen
- Zusammenfassen
- Ziele bis zur nächsten Sitzung setzen

Leitlinie 6: Austausch fördern

- Zuhören
- Produktive Debatten ermöglichen
- Entwürfe diskutieren
- Erst das Positive
- Vorschläge mit Hinweis auf Leserbedürfnisse begründen
- Änderungsvorschläge priorisieren: Welche Änderungen
bringen den grössten Effekt?
- Substantielle Vorschläge und Stilfragen trennen.
- Vorschläge des Teams für eigene Texte entgegennehmen
und für Feedback danken

Erfolgsfaktoren technische Unterstützung

Programm und Namenskonvention

Versionierung

Master-Dokument (Template)

Erarbeitungs- und Überarbeitungsprozess

Kommentare ermöglichen, Änderungen nachverfolgbar machen

 

Qualitätskriterien für technische Dokumente

!!!

• Verständlichkeit: Sind Ihre Beschreibungen auch für den fachunkundigen Kunden verständlich?
• Eindeutigkeit: Sind mögliche Fehlinterpretationen Ihres Kunden ausgeschlossen?
• Adäquatheit: Beschreiben Sie auch wirklich das, was der Kunde fordert?
• Vollständigkeit: Beschreiben Sie auch alles, was der Kunde fordert?
• Konsistenz: Sind Ihre Beschreibungen frei von Widersprüchen?
• Prüfbarkeit: Kann anhand Ihrer Beschreibungen überprüft werden, ob das Zielprodukt die Anforderungen erfüllt?

Optimierungsstrategie: Eigenen Entwurf prüfen

Um eigene Entwürfe prüfen zu können brauchen Sie zeitliche Distanz zum Entwurf.
Entwurf aus verschiedenen Perspektiven lesen:
- Leser
- Firma
- Stakeholder
Sie haben nur für einen Aspekt wirklich Aufmerksamkeit
Welche Fehler findet das Korrekturprogramm Ihrer Textverarbeitung nicht?

Beurteilungsraster Netzdossier

Informationsgehalt
o Ist die Information relevant?
o Ist die Information aktuell?
o Ist die Information nützlich?
o Enthält der Text aussagekräftige Abbildungen/Schemata?
o Enthält der Text Praxisbeispiele?
Strukturierung
o Ist der Text gut strukturiert und portioniert?
o Sind die Teaser- und Leadtexte aussagekräftig?
o Enthält der Text ein Inhaltsverzeichnis?
o Enthält der Text sprechende Zwischentitel?

Vernetzung
o Ist der Text intern und extern gut verlinkt?
o Funktionieren alle Links?
o Haben die Links sprechende Linktexte?
o Sind die Links kommentiert?
Stilistik
o Ist der Text gut verständlich?
o Ist die Sprache an die Zielgruppe angepasst?
o Ist die Sprache präzise?
o Ist der Text logisch kohärent?
Korrektheit
o Ist die Grammatik korrekt?
o Ist die Rechtschreibung korrekt?
o Sind die Quellennachweise korrekt?

*** Standardisierung und Terminologie ***

Benennungswirrwarr

Inkonsistenz
„Die Unterrichtsbeurteilung wird umbenannt von „Q-Feedback“ in „Lehrbeurteilung“ und nur noch elektronisch durchgeführt.“
Pop-up, pull-down, drop-down
window, screen
Ungenauigkeit
Bestellung: Kundenbestellung, Bestellung im Einkauf, interne Bestellung
Auftrag: Kundenauftrag, Fertigungsauftrag, Wartungsauftrag

Definition und Begriffserklärung

Definitionsarten innerhalb eines Begriffssystems
1. Begriffsbeschreibung durch Angabe der Merkmale des Begriffsinhalts, die auf ein Begriffssystem bezogen sind (Begriffsintension);
2. Begriffsbeschreibung durch Angabe der Gesamtheit aller Unterbegriffe, die auf derselben Abstraktionsstufe stehen (Begriffsextension).
Begriffserklärung
ohne Bezug auf ein Begriffssystem
Begriffsbeschreibung durch Angabe der Merkmale des
Begriffsinhalts ohne Bezugnahme auf ein Begriffssystem

Woraus besteht ein Fachausdruck

bild

Inhalte einer Terminologie

alle Fachausdrücke, die für das unmissverständliche Verstehen der Dokumente ausschlaggebend sind

Für den einzelnen Fachausdruck:
Benennung in der gültigen Schreibweise
Begriff, d.h. der definierte Inhalt
Verständliche Erklärung
ggf. eine Übersetzung

Aufbau einer Terminologie

1. Fachausdrücke, Absichten und Verwendungskontexte kategorisieren
2. Bedeutungen recherchieren und klären
3. Benennung und Schreibweise festlegen
4. Begriff definieren
5. Ausdruck ggf. erklären
6. Ausdruck ggf. übersetzen
7. Terminologie zugänglich machen pflegen

Beispiel Begriffsdefinition

!!!

bild

Zusammenfassung

Die alltägliche Sprachverwendung birgt Potential für vielfältige Missverständnisse.
Ausdrücke können sowohl zur Fachsprache als auch zur Standardsprache gehören. Je nach Verwendungskontext kann ihre Bedeutung variieren.
Einheitliche Sprachverwendung (Terminologie) im Unternehmen leistet einen Beitrag zur Verständlichkeit der Kommunikation im Unternehmen. Inhalt einer Terminologie im Unternehmen sind die produkt-, unternehmens- und fachspezifischen Ausdrücke.

Lernen