Rechtskonform erstellen, benutzerfreundlich gestalten, wirtschaftlich realisieren
Datenbank, Deutsch, Online-Publikationen
WEKA
– Qualität, Sicherheit und Kostenoptimierung von Anfang an: Mit dieser Praxislösung entwickeln Sie Ihre Technischen Dokumentationen verständlich, rechtskonform und wirtschaftlich. Von der Konzeption über die Auswahl geeigneter Arbeitsmittel und Werkzeuge bis hin zur Auslieferung finden Sie hier alle wesentlichen Informationen und Arbeitshilfen, mit denen Sie Schritt für Schritt zu rechtssicheren Ergebnissen kommen.
– Anschauliche Beispiele erleichtern Ihnen die Erstellung benutzerfreundlicher Dokumente. Sie erfahren, was leicht verständliche Anleitungen ausmacht und wie Sie Ihre Texte visuell unterstützen können.
– Klare Musteranleitungen ersparen Ihnen langwierige Recherchen. Sie zeigen Ihnen, was sich bewährt hat und wie Sie die fachlichen, rechtlichen und normativen Forderungen gezielt umsetzen. Folgende Musteranleitungen sind in Word, FrameMaker und InDesign enthalten: Betriebsanleitung, Montageanleitung, Service-Manual, Bedienungsanleitung. Zusätzlich unterstützen Sie detaillierte Kalkulationshilfen, Checklisten, Vorlagen und zahlreiche Tipps bei der kostensparenden, effizienten Realisierung Ihrer Projekte.
Aus dem Inhalt:
– Themen A bis Z zur Technischen Dokumentation
– Dokumentationsprozess: die praxisorientierte Anleitung
– Arbeitsmittel und Software-Werkzeuge: Welche Anschaffung lohnt sich?
– Strategien, Trends, Möglichkeiten
– Gesetze und Normen: Das müssen Sie wissen!
– Mit dabei: Arbeitshilfen und Musteranleitungen mit Textbausteinen in MS Word, FrameMaker und InDesign
Autoren/Hrsg.
Fachgebiete
Weitere Infos & Material
Was ist neu?
Wegweiser
Autorenverzeichnis
Nützliche Websites
Über uns
– Service
– Weitere Produkte
Grundlagen
Was verstehen wir unter Technik-Dokumentation?
Anforderungen an die Technik-Dokumentation
Konzeptionierung von Anleitungen
– Erforderliche Vorarbeiten
– Produktanalyse
– Zielgruppenanalyse - den Nutzer stets im Blick!
– Risikobeurteilung - die Basis jeder Anleitung
– Interviewtechniken
– Wider den Tunnelblick!
Prüfen und Optimieren von Anleitungen
– Prüfen und Optimieren von Anleitungen
– Prüfbeispiel 1: Anleitung für eine digitale Zeitschaltuhr
– Prüfbeispiel 2: Anleitung für ein TV-Gerät
– Prüfbeispiel 3: Anleitung für ein Duo-Funktelefon
Anleitungen unter der Lupe
– Anleitung für einen Warmwasserspeicher
– Anleitungen für Fahrräder
– BMW-App Driver's Guide: mobile Anleitung nach Maß
Qualität, Qualitätsmanagement und Technik-Dokumentation
– Anleitungen: Kann man sie nicht spannender machen?
Grundlagen der Elektrotechnik für die Technik-Redaktion
Grundlagen der Elektrotechnik für die Technik-Redaktion, Teil 2
Konzeptionierung einer Technik-Dokumentation
Projektplanung
Grundbausteine der Texterstellung
– Verständlichkeit - ein Muss für technische Texte
– Formulierung und Stil
– Grundlagen der Terminologiearbeit
– Mehrdeutigkeit vermeiden
– Mit kreativen Elementen zum Lesen motivieren
– Fassen Sie sich kurz!
– Treffende Benennungen finden
Texte gliedern und gestalten
– Textgliederung
– Bestandteile von Technik-Dokumenten
– Layout: Orientierung geben
– Typografie: Lesefreundlichkeit schaffen
– Der Wegweiser - die Anleitung zur Anleitung
– Spezialfall: zielgruppengerechte Software-Dokumentation
– Anleitungen zielgerichtet finden
– Navigation -? Inhalte finden
– Minimalistische Anleitungen
Spezifische Texte
– Eindeutige Instruktionen geben
– Sicherheits- und Warnhinweise
– Abkürzungen richtig verwenden
– Fachwörter in Technik-Dokumenten
– Verzeichnisse und spezielle Kapitel
– Sonderzeichen: Bedeutung und Problematik
– Technik-Englisch ist anders
– Technik-Englisch: Schreibstil und Satzzeichen
– Benennungen im Technik-Englisch: Hauptwörter
– Benennungen im Technik-Englisch: Adjektive und Verben
Grundbausteine der Bildgestaltung
– Methoden der Visualisierung
– Abbildungen - den Einsatzzweck und die Kosten bedenken
– Vier Grundtypen der Text- und Bildgestaltung
– Textfreie Dokumentationen
– Piktogramme selbst entwickeln
Technik-Illustrationen
– Zwei- und dreidimensionale Illustrationen
– Perspektivische Darstellungen
– Illustration praktisch: die Isometrie
– Metadaten pflegen und Technik-Illustrationen wiederfinden
Technik-Fotografie
– Grundlegende Techniken
– Kamerasysteme
– Tipps zur digitalen Fotografie
– Die Bildaussage gestalten mit der Brennweite
Bildbearbeitung
– Grundlegende Techniken
– Fehler- und Kostenabschätzung bei der Bildbearbeitung
– Umgang mit Grafiken in Microsoft Word
3-D-Computergrafik
Strukturierung von Dokumentationen
– Methoden der Strukturierung
– Strukturieren mit XML
– Strukturvorgaben für die Praxis
– Strukturieren mit Publishing-Werkzeugen
– Strukturiert denken - mit Mindmapping zu effizienterem Arbeiten
– Funktionsdesign®
Modularisierungskonzepte
Standardisierung
– Redaktionsleitfaden - das Ende der Leiden mit dem Leitfaden
– Praxisbeispiel: Revision eines Redaktionsleitfadens - mit Nebeneffekten
– Redaktionsrichtlinie selbst gemacht
Schnittstellen in der Technik-Redaktion
– Ohne Kommunikation keine gute Dokumentation
– Gebrauchstauglichkeit (Usability)
Die praxisorientierte Anleitung
Die Bedienungsanleitung
– Bedienungsanleitung: Mustervorlagen
– Praxisbeispiel 1: Funksystem "SecuSignal®"
– Praxisbeispiel 2: Smartphone "Palm Treo 650"
– Praxisbeispiel 3: Outdoor-Notebook "Panasonic CF-29"
Die Betriebsanleitung
– Betriebsanleitung: Mustervorlagen
– Praxisbeispiel 1: Betriebsanleitung einer Sondermaschine
– Praxisbeispiel 2: Digitaler Servoverstärker JetMove 206-230
– Praxisbeispiel 3: Rotationsmodul
Die Montageanleitung
– Montageanleitung: Mustervorlagen
– Praxisbeispiel 1: Wannenträgersystem
– Praxisbeispiel 2: Rollcontainer
– Praxisbeispiel 3: Fahrradkindersitz
– Anleitungen unter der Lupe: Montageanleitung Solarmodultragsystem
Das Service-Manual
– Service-Manual: Mustervorlagen
– Praxisbeispiel: Erstellung eines Service-Manuals für ein Gerät der Medizintechnik
Die Kurzanleitung
– Praxisbeispiel: Reizstromgerät
Die textfreie Anleitung
– Praxisbeispiel: Entwicklung einer textfreien Montageanleitung für eine Türdrückergarnitur
– Praxisbeispiel: Dieselmotor, Aufkleber
– Praxisbeispiel: Vibrationswalze
– Praxisbeispiel: Autoalarmanlage
– Praxisbeispiel: Rollcontainer
Anleitungen für spezielle Zielgruppen
– Praxisbeispiel: Anleitung für ein Seniorenhandy
Historische Anleitungen
– Einführung
– Praxisbeispiel: Anleitung zum Tiger-Panzer (1943)
Zulieferdokumentation
– Umgang mit Zulieferdokumenten
Arbeitsmittel und Werkzeuge der Technik-Redaktion
Arbeitsmittel
– Hardware
– Fachliteratur fürs Redaktionsbüro
– Mobile Technik-Dokumentation
Werkzeuge: Software und Systeme
– Betriebssysteme
– Publishing-Systeme
– Illustrationssoftware
– Bildbearbeitungssoftware
– Redaktionssysteme
– Dokumentenmanagementsysteme
– Terminologielösungen
– Standardtools für die Technik-Redaktion
– Nützliche Zusatztools und Technologien
Praxistipps
– Word: Dokumentvorlagen intelligent konfigurieren
Datenmanagement
Daten drucken
– Dokumente für den Druck vorbereiten
– Vervielfältigungs- und Druckverfahren
– Datenformate - Probleme und Lösungen
– Dateigröße von Dokumenten mit Grafiken optimieren
– Farbrichtig produzieren
– Kooperation mit Druckereien
Daten sichern
– Datenverlust vorbeugen und Supportaufwand begrenzen
– Tipps für Sicherungsmuffel
Daten archivieren
– Voraussetzungen für verlässliche Datenarchivierung
– Eine intelligente Datenstruktur anlegen
– Datenaustauschformate für die Archivierung
– PDF/A für die Langzeitarchivierung
Daten schützen
– NSA & Co. - aktiv nichts tun oder sich schützen?
– Datensicherheit: Experteninterview
Daten auslagern
– Cloud Computing
– Dropbox
Übersetzungsmanagement
Qualität durch professionelle Übersetzer
Wie kommuniziere ich mit einem Übersetzer?
Lokalisierung von Technik-Dokumentationen
Rechtsprobleme bei Übersetzungen
Integration von Redaktionssystemen und Übersetzungsmanagement
Übersetzungsgerechtes Schreiben
Online- und mobile Dokumentationen
Online-Dokumentation im Überblick
Details, Tipps und Tricks
– Online-Hilfen
– MadCap Flare - mächtige Suite für das technische Schreiben
– Erstellen von Software-Tutorials
– Visualisierungsobjekte in Online-Dokumentationen
– Online-Dokumentationen mit CMS - ein praktischer Leitfaden
– On-Screen-Dokumentationen gestalten
– Einsatzgebiete von Multimediaanwendungen
Tools und Standards
– HTML5 für die Technik-Dokumentation
– Online-Medien effizienter gestalten mit SCSS
– Multimediales Informations-Struktur-Design: der Rahmen für Technik-Dokumentation auf mobilen Medien
Mobile Technik-Dokumentation
– Mobil mit altbekannten Werkzeugen
– Bedienungsanleitungen auf dem iPad - mit Fallstudie
– Anleitungen für Smartphones optimieren - mit dem Standardformat EPUB
– Die besten Apps für den Arbeitsalltag in der Redaktion
– App2Anleitung: per App zur Anleitung
Strategien, Trends, Möglichkeiten
Aktuelle Trends
– Trends, Tipps & Tricks für die Technik-Redaktion 2015
– Anleitungen: Kleine Feldstudie über das Schubladendenken
– Bedienungsanleitungen - bald nur noch digital?
– Trends, Tipps & Tricks für die Technik-Redaktion 2016
Der Technik-Redakteur
– Sieben Tipps für Ihr Selbstmanagement
– Schreibblockaden und was man dagegen tun kann
– Der Redakteur als Berater
– Die Technik-Redaktion im Unternehmen
– Arbeitsmarkt Technik-Kommunikation
– Aus- und Weiterbildung von Technik-Redakteuren
Agil dokumentieren
– Scrum in der Technik-Redaktion
– Kanban in der Technik-Redaktion
– Scrum in der Medizintechnik
Sach- und Industriefilm
– 4 x 4 - im Viererschritt durch den Sach- und Industriefilm
– Utility-Film: zeigen statt schreiben
Zielgruppenspezifische Technik-Dokumentationen
– Technik-Dokumentationen für Senioren
– Technik-Dokumentationen für Kinder
– Funktionaler Analphabetismus
Hybriddokumentation
Aus die Maus: Gebrauchstauglichkeit neuer Eingabegeräte
Make or buy
– Make or buy
– Wirtschaftlich dokumentieren im Unternehmensverbund
– Outsourcing - Chancen für Hersteller und Dienstleister
Neue Arbeitswelten
– Technik-Kommunikation 4.0
Technik-Kommunikatoren im Profil
– Über die Schulter geschaut: Sissi Closs im Profil
– Über die Schulter geschaut: Dr. Matthias Hattemer im Profil
– Über die Schulter geschaut: Elisabeth Wirthmüller im Profil
– Über die Schulter geschaut: Dieter Gust im Profil
– Über die Schulter geschaut: Waldemar Piontek im Profil
– Über die Schulter geschaut: Olaf Weiske im Profil
– Über die Schulter geschaut: Lars Momberg im Profil
Gesetze und Normen: Das müssen Sie wissen!
Konzept- und Planungsphase
– Gesetzliche Vorschriften
– Organisationsverantwortung
– Schadensersatzansprüchen vorbeugen
– Konformität mit EG-Richtlinien
– Harmonisierte europäische Normen
– Sonstige Normen und Vorschriften
– Stand der Technik
– Gesamtheit von Maschinen - Erweiterungen/Austausch von Baugruppen - das müssen Sie wissen
– Vom GPSG zum neuen Produktsicherheitsgesetz (ProdSG) - die wichtigsten Änderungen
– Die DIN EN ISO 12100 im Überblick
– Entwurf zur neuen Niederspannungsrichtlinie
– Richtlinie VDI 4500: Blatt 4 ist erschienen
– Neues zur ATEX-Richtlinie
– DIN EN 82079-1
– Zusätzliche Gefährdungen aufgrund der Beweglichkeit einer Maschine dokumentieren - das müssen Sie wissen
– Blue Guide und "Neuer Rechtsrahmen"
– Die acht neuen EU-Richtlinien von 2014/2016
– VDI-Richtlinie 4500, Blatt 5 - Dokumentationsprozess: Wirtschaftlich dokumentieren
– Die Rolle von Anleitungen in der Betriebssicherheitsverordnung 2015
– Wesentliche Veränderung von Maschinen
– Risikobeurteilung: Status quo
Produktionsphase
– Qualitätsforderungen recherchieren
– Urheberrecht, Copyright und Impressum
– Dreistufige Integration der Sicherheit
– Risikobeurteilung als Quelle der Sicherheitsinstruktion
– Grundlegende Sicherheitshinweise
– Aufgabenbezogene Warnhinweise platzieren, formulieren und gestalten
– Rechtliche Aspekte von Sicherheits- und Warnhinweisen
– Zulieferdokumente integrieren und/oder referenzieren
– Übersetzungen vorbereiten
– Anlagendokumentation
– Geräuschemission gesetzes- und normkonform dokumentieren
Optimierungsphase
– Qualitätssicherung
– Qualitäts-Check für die Betriebsanleitung
– Freigabeprozess
– Verteilung technischer Dokumentationen: gedruckt oder elektronisch?
– Von der EG-Konformitätserklärung zur CE-Kennzeichnung
– Archivierung
– Änderungsdienst
– Rückrufmanagement
Vorschriften: Originaltexte
– Bürgerliches Gesetzbuch
– Blue Guide
– Geräte- und Produktsicherheit
– Maschinenrichtlinie 2006/42/EG
– Niederspannungsrichtlinie 2006/95/EG
– Niederspannungsrichtlinie 2014/35/EU
– ATEX-Richtlinie 2014/34/EU
– Produkthaftung
– Urheberrechtsgesetz
– Medizinproduktegesetz
– Chemikaliengesetz
– Strafgesetzbuch
Newsletter Technische Dokumentation konkret
Ausgabe Mai 2016
Ausgabe Februar 2016
Ausgabe November 2015
Newsletter-Archiv
– Ausgabe August 2015
– Ausgabe Mai 2015
– Ausgabe Februar 2015
– Ausgabe November 2014
– Ausgabe August 2014
– Ausgabe Mai 2014
– Ausgabe Februar 2014
– Ausgabe November 2013
– Ausgabe August 2013
– Ausgabe Mai 2013
– Ausgabe Februar 2013
– Ausgabe November 2012
– Ausgabe August 2012
– Ausgabe Mai 2012
– Ausgabe Februar 2012
eBooks zum Thema Technische Dokumentation
Pocketguide für die Technik-Redaktion
– Pocketguide für die Technik-Redaktion
– Autorenverzeichnis
– 1.100
– A
– B
– C
– D
– E
– F
– G
– H
– I
– J
– K
– L
– M
– N
– O
– P
– Q
– R
– S
– T
– U
– V
– W
– X
– Z
– Anhang: Nützliche Internetadressen
TechDok light
– Vorwort
– Dokumentationsprozess allgemein
– Rechtliche Rahmenbedingungen
– Autorenverzeichnis
ATEX-Richtlinie in der Technischen Dokumentation
– Der Autor
– Einleitung
– Was regelt die ATEX-Richtlinie?
– Betriebsanleitung und ATEX-Richtlinie
– Checklisten und Formblätter zur ATEX-Betriebsanleitung
Pocketguide PDF
– Autorenporträts
– Vorwort
– Acrobat und Co. - Software für PDF
– PDF-Dateien erzeugen
– PDF-Dateien editieren
– Elektronisch publizieren mit PDF
– PDF und Multimedia - eine Fallstudie
– Verwertbare Daten aus PDF-Dateien gewinnen - mit Acrobat
– Der Weg zurück - Konvertieren von PDF-Dateien ohne Acrobat
– Sind PDF-Dateien sicher?
– Acrobat und Word - das Team für Farbtreue
– Tipps und Tricks
– Zum Weiterlesen und Surfen