Lek4 - Dokumentkonzept

1.     Das Konzept bildet die Basis für die Erstellung einer Dokumentation

2.     Berücksichtigt die Ergebnisse aus Dokument-, Produkt- und Nutzeranalyse sowie die Vorgaben des Auftraggebers

3.     Detaillierte Beschreibung wie die Dokumentation umzusetzen ist

4.     Ein gutes Konzept kann wieder und wieder verwendet werden!

1.      Sofortanleitung: Informationen sofort in Handlungen umsetzen

2.      Lernanleitung: Bedienung Schritt für Schritt lernen

3.      Nachschlageanleitung: gesuchte Informationen schnell finden

§  Schnell verfügbar

§  Schnell überschaubar

§  Klar und deutliche Benutzerführung

§  Viel Visualisierung

§  Nennen des Handlungsziels

§  Lineare Beschreibung der Tätigkeit

§  Kurz und prägnant

—> Lesen – Handeln – Vergessen

§  Umfangreicher und kompliziertere Inhalte

§  Aufgebaut von leicht zu schwer

§  Eingeteilt in einzelne Lerneinheiten

§  Systematische Vermittlung von Wissen

§  Beispiele zur Konkretisierung

§  Übung und Kontrolle

§  Transfer möglich

§  Unterstützt das individuelle Lernen

§  Möglichkeit im Dokument vor- und zurückzuspringen, Informationen nachzulesen, Wissen zu vertiefen

§  Vermittlung von Kontext, Hintergründen, Merkhilfen

—> Lesen – Handeln - Behalten

§  Starke Strukturierung der Information für sofortige Übersicht

§  Einheitliche, effiziente Darstellung durch Tabellen

§  Querverweise, Inhaltsverzeichnisse, Glossar

§  Kurz und Prägnant

§  Informationsdichte steht über Verständnistiefe

§  Anspruch auf Vollständigkeit

—> Finden – Benutzen - Vergessen

1.      Leistungsbeschreibung

2.      Gerätebeschreibung

3.      Tätigkeitsbeschreibung (z.B. Handlungsanweisungen, Vermittlung der Systematik, Exemplarische Einführungen)

4.      Beschreibung der Funktionsweise

5.      Technische Unterlagen (z.B. Daten, Zeichnungen, Schaltpläne, Ersatzteillisten)

1. Impressum

2. EG-Konformitätserklärung

3. Produktbeschreibung

4. Handlungsbeschreibung (Betrieb der Maschine)

5. Anleitungen zur Montage, zum Aufbau und zum Anschluss der Maschine + Inbetriebnahme

6. Einrichtungs- und Wartungsarbeiten

7. Angaben zu Restrisiken + Schutzmaßnahmen

8. Zusatzgeräte

9. Bedingungen, unter denen die Maschine die Anforderungen an die Standsicherheit beim Betrieb, beim Transport, bei der Montage, bei der Demontage, wenn sie außer Betrieb ist, bei Prüfungen sowie bei vorhersehbaren Störungen erfüllt

10. Sicherheitshinweise zum Transport, zur Handhabung und zur Lagerung, mit Angabe des Gewichts der Maschine und ihrer verschiedenen Bauteile, falls sie regelmäßig getrennt transportiert werden müssen

11. bei Unfällen oder Störungen erforderliches Vorgehen

12. Spezifikationen der zu verwendenden Ersatzteile, wenn diese sich auf die Sicherheit und Gesundheit des Bedienungspersonals auswirken

13. Angaben zur Luftschallemission der Maschine

     der A-bewertete Emissionsschalldruckpegel an den Arbeitsplätzen, sofern er 70 dB(A) übersteigt; ist dieser Pegel kleiner oder gleich 70 dB(A), so ist dies anzugeben;

     der Höchstwert des momentanen C-bewerteten Emissionsschalldruckpegels an den Arbeitsplätzen, sofern er 63 Pa (130 dB bezogen auf 20 µPa) übersteigt;

     der A-bewertete Schallleistungspegel der Maschine, wenn der A-bewertete Emissionsschalldruckpegel an den Arbeitsplätzen 80 dB(A) übersteigt

    
    

• Grundlegende Teile einer Betriebsanleitung (Titelseite, Inhaltsverzeichnis, Einleitung)

• Sicherheit

• Maschinenübersicht (Maschinenbeschreibung, Bestimmungsgemäße Verwendung)

• Transport, Handhabung und Lagerung

• Montage, Installation und Inbetriebnahme

• Herstellereinstellungen

• Betrieb (Betriebsarten, Einschalten und Ausschalten der Maschine, Ablauf oder Reihenfolge von Vor-gängen, falls erforderlich, andere Anleitungen zum Betrieb)

• Produkt- oder Kapazitätswechsel

• Inspektion, Prüfung und Instandhaltung

• Fehlersuche/Störungsbeseitigung und Reparatur

• Demontage, Außerbetriebnahme und Entsorgung

• Dokumente und Zeichnungen

• Stichwortverzeichnis, Glossar, Anhänge