Technische Dokumentation

Die EG-Baumusterprüfung ist Teil eines von der Europäischen Union vorgeschriebenen und Konformitätsbewertung genannten Verfahrens, mit dem bestimmte Produkte (z.B. Medizinprodukte oder Produkte nach den ATEX-Richtlinien) vor deren Inverkehrbringen auf die Einhaltung von EU-Normen zu prüfen sind. Die rechtliche Grundlage hierfür sind verschiedene Richtlinien im Rahmen des sogenannten Neuen Konzepts von 1985, auf dessen Grundlage europaweit einheitliche Mindestanforderungen zu gewährleisten sind. Baumusterprüfungen werden durch sogenannte Benannte Stellen durchgeführt.

www.gesetze-im-Internet.de und Seiten der Europ. Kommission zu Richtlinien und Verordnungen, z.B. https://europa.eu/european-union/eu-law/legal-acts_de

Konformität mit den Anforderungen einschlägigen EU-Richtlinien, die der Produktsicherheit dienen. Keine geprüfte Sicherheit!

verschuldensabhängig: Mindestens Vorsatz oder Fahrlässigkeit erforderlich

verschuldensunabhängig: Es ist egal, ob Vorsatz oder Fahrlässigkeit vorlagen. Maßgeblich ist allein, ob das Produkt einen Fehler hatte, der zu einem Schaden geführt hat.

Grundsätzlich ist die Betriebsanleitung in der Landessprache bereitzustellen. Sonderregelung bei Maschinenrichtlinie für Wartungsanleitungen

§823 BGB und §1 ProdHG

Bei der Beurteilung, ob ein Produkt der Anforderung nach Satz 1 entspricht, sind
insbesondere zu berücksichtigen: 

• die Eigenschaften des Produkts (einschließlich seiner Zusammensetzung, seiner Verpackung, der Anleitungen für seinen Zusammenbau, der Installation, der Wartung und der Gebrauchsdauer, der Aufmachung des Produkts, seiner Kennzeichnung, der Warnhinweise, der Gebrauchs- und Bedienungsanleitung, der Angaben zu seiner Beseitigung sowie aller sonstigen produktbezogenen Angaben oder Informationen)
• Sind bei der Verwendung, Ergänzung oder Instandhaltung eines Produkts bestimmte Regeln zu beachten, um den Schutz von Sicherheit und Gesundheit zu gewährleisten, ist bei der Bereitstellung auf dem Markt hierfür eine Gebrauchsanleitung in deutscher Sprache mitzuliefern, sofern in den Rechtsverordnungen nach § 8 keine anderen Regelungen vorgesehen sind. (§ 8 regelt Rechtsverordnungen)

Erlöschen von Haftungsansprüchen nach 10 Jahren

Erklärung über die Übereinstimmung des Produktes mit den anwendbaren Richtlinien

• Typ-A-Normen (Sicherheitsgrundnormen) behandeln Grundbegriffe, Gestaltungsleitsätze und allgemeine Aspekte, die auf Maschinen angewandt werden können
• Typ-B-Normen (Sicherheitsgruppennormen) behandeln einen Sicherheitsaspekt oder eine Art von Schutzeinrichtungen, die für eine ganze Reihe von Maschinen verwendet werden können
• Typ-C-Normen (Maschinensicherheitsnormen) behandeln detaillierte Sicherheitsanforderungen an eine bestimmte Maschine oder Gruppe von Maschinen.

tekom-Normenkommentar, ISO-website, IEC-website, Beuth

• DIN (Deutsches Institut für Normung) – Deutsche Norm bzw. in Deutschland übernommene Norm
• EN (Europäische Norm von CEN, CENELEC oder ETSI)
• ISO (International Organisation for Standardization, internationale Norm)

Aussage ist korrekt. Es gibt im Grunde nur 2 Ausnahmen:

• Man hat sich vertraglich zur Anwendung verpflichtet
• In ganz seltenen Fällen können Normen quasi Gesetzesstatus haben (z.B. bestimmte Normen in China)

• Die Betriebsanleitung muss in einer oder mehreren Amtssprachen der Gemeinschaft abgefasst sein. Die Sprachfassungen, für die der Hersteller oder sein Bevollmächtigter die Verantwortung übernimmt, müssen mit dem Vermerk „Originalbetriebsanleitung“ versehen sein.
• Ist keine Originalbetriebsanleitung in der bzw. den Amtssprachen des Verwendungslandes vorhanden, hat der Hersteller oder sein Bevollmächtigter oder derjenige, der die Maschine in das betreffende Sprachgebiet einführt, für eine Übersetzung in diese Sprache(n) zu sorgen. Diese Übersetzung ist mit dem Vermerk „Übersetzung der Originalbetriebsanleitung“ zu kennzeichnen.
• Abweichend von den vorstehenden Bestimmungen kann die Wartungsanleitung, die zur Verwendung durch vom Hersteller oder von seinem Bevollmächtigten beauftragtes Fachpersonal bestimmt ist, in nur einer Sprache der Gemeinschaft abgefasst werden, die von diesem Fachpersonal verstanden wird.
• Für die Abfassung der Konformitätserklärung sowie deren Übersetzungen gelten die gleichen Bedingungen wie für die Betriebsanleitung

DIN EN 82079-1 Erstellen von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung – Teil 1: Allgemeine Grundsätze und ausführliche Anforderungen.
Die Norm richtet sich an Personen, die an der Konzeption und Erarbeitung von Gebrauchsanleitungen beteiligt sind -- allen voran Technische Redakteure, aber beispielsweise auch Übersetzer, Softwareentwickler und Technische Zeichner.
Die DIN EN 82079-1 hat einen sehr weiten Anwendungsbereich. Sie bezieht sich auf die Erstellung von Gebrauchsanleitungen für einfache Produkte genauso wie auf die Erstellung von Betriebsanleitungen für komplexe Anlagen.

Richtlinien von Fachverbänden wie tekom oder VDI

• Lehrfunktion
• Handhabungsfunktion
• Suchfunktion
• Orientierungsfunktion
• Nachschlagefunktion
• Logistische Funktion (Ersatzteilliste!)
• Marketingfunktion (Interesse wecken)
• Entscheidungshilfe beim Kauf

Ein CMS für die Technische Dokumentation bietet in aller Regel

• Modularisierung
• Variantenmanagement
• Übersetzungsmanagement
• Versionsmanagement
• Layout-Automatisierung
• Single Source Publishing

Ted Nelson

Ein Gedanke, eine Aussage, z.B. Erklärung eines Begriffs

Inhalt
soll in unterschiedlichen Zusammenhängen verwendbar sein
soll einer Systematik folgen

Verwaltung
wird in der Regel als separates Element (Datei, Objekt) verwaltet
wird (in Onlinehilfesystemen oder DITA-Tags) mit Metadaten angereichert

• nur 1 Aussage
• muss korrekt sein
• minimalistisch (keine unnötigen Informationen)
• präzise (Wortwahl, Bezüge, Platzierung)
• konsistent (Schreibweise, Struktur, Detailtiefe)

Es besagt, dass Texte besser verstanden und behalten werden, die folgende Kriterien erfüllen:

• Einfachheit (kurze Sätze (9 bis 13 Wörter), kurze Wörter (dreisilbig), vertraute Wörter (keine Fremdwörter oder Fachbegriffe),
• Gliederung (nur ein Gedanke pro Satz, das Wesentliche zu Beginn des Textes und zu Beginn eines Satzes, Sinnzusammenhänge durch Absätze anzeigen)
• Prägnanz (Verben statt Substantivierungen, eine bildhafte Sprache)
• Anregung (erklärende Bilder und Grafiken)

• Zielgruppen-Eignung
• Korrektheit
• Konsistenz
• mediengerechte Aufbereitung der Information
• effizienter Zugang zur gewünschten Information
• einfache Handhabung

Es beschreibt die Beziehungen zwischen

• einem Gegenstand (in der Realität)
• seiner Benennung (in der Sprache)
• und dem dahinterliegenden Begriff (abstrakt, im Denken)

Augmented Reality - 'erweiterte Realität' ; zu finden in modernen Anleitungen. Dabei zielt man mit Tablet oder Smartphone auf ein Bedienelement und bekommt es textlich erklärt - z.B. im PKW

Meist wird durch eine Nominalisierung dem Verb die Bedeutung entzogen. Deshalb muss ein anderes Verb herhalten, das den Sinn des Satzes nicht verändert (=Funktionsverb).

Beispiele:

• Messung durchführen (statt "messen")
• Kontrolle vornehmen (statt "kontrollieren")
• zum Einsatz kommen (statt "einsetzen")

 (Qu.: Duden, Ratgeber Techn. Dokumentation, p 105)

hinweisende Funktion von Wörtern (z. B. Pronomen wie dieser, jener, Adverbien wie hier, heute) in einem Kontext (Qu.: Duden-Website). Kann in der TD je nach Kontext zu missverständlichen Anweisungen führen, daher möglichst zu vermeiden.

Unter die Gruppe der Modalverben fallen folgende Wörter: können, wollen, sollen, müssen, mögen und dürfen. In der TD ist es in aller Regel sinnvoll, Modalverben gezielt zu verwenden oder zu vermeiden. (Qu.: Duden-Ratgeber TD, p 111)

Ich würde der Aussage insofern zustimmen, als gesprochene Sprache meistens leichter zu verstehen ist als Schriftsprache. Und eine Hauptanforderung an TD ist, verstanden zu werden. (Qu.: ist mir beim Lesen des Duden-Ratgebers TD eingefallen, könnte auch irgendwo wörtlich so drinstehen ;-))

Vorgehensmodell in sieben Schritten: 

1. Analyse IST (Reengineering, Rauswerfen von Überkommenem, Überflüssigem, Bewahren des Guten)
2. Bewertung vorhandener Informationsprodukte und Analyse künftiger Anforderungen
3. neue Klassifizierung der vorhandenen und notwendigen Informationsprodukte wie Bed.-Anl., Montageanl., Wartungshandbuch, Hilfesystem usw.
4. Definition der erforderlichen Funktionalen Elemente für alle Informationsprodukte ("Kerngeschäft" des FD-Standard-Entwicklers)
5. Dokumentation der Festlegungen für alle Funktionalen Elemente in einem Leitfaden
6. Zusammenführung der FE mit der jeweiligen Tool-Umgebung, insbesondere geeignet ist XML (und dort DITA) 
7. Implementierung, Schulung, Erstellen von Musterdokumenten

Entscheidend: Festlegen, welche kommunikativen Handlungen die Autoren für einen bestimmten Informationsprodukt-Typ verwenden dürfen.

Ebenenmodell: Bei der funktionalen Betrachtung von Informationsprodukten unterscheidet die Funktionsdesign-Methode vier Ebenen.

1. Art des Informationsprodukts (Betriebsanleitung, Wartungsanleitung...)
2. Sequenzmuster (Handlungssequenz, Warnhinweis...)
3. Funktionale Einheit (Themenangabe, Zielangabe, Voraussetzung, Einführung, Erklärung, Maßnahme, Handlungsaufforderung, Resultat der Handlung...)
4. Auszeichnungselement (Produktnamen, Benutzer-Eingabe, Codephrase, Displaymeldung...)

(Qu.: aus verschiedenen Quellen und der Master-Veranstaltung von J. Muthig von Achim zusammengetragen bzw. abgeschrieben)

Abstraktionsindex: AI-Prozent = Summe Substantive mit Abstraktionssuffix * 100 / Gesamtzahl Substantive
AI 0-6,25%: sehr konkret
AI 7-12,5%: konkret
AI 12,8-25%: mittelmäßig abstrakt oder konkret
AI 25,25-31,23%: abstrakt
AI >31,25%: sehr abstrakt

Qu.: Lehrndorfer-Skript p28