Eine Technische Dokumentation umfasst alle Produktinformationen und auch Produkt begleitenden Informationen, d.h. von der kompletten Anleitung bis hin zu Detailgrafiken und Datenblättern.
Systematische Aufbereitung und strukturierte Präsentation der Informationsinhalte in Art und Umfang entsprechend dem Zweck kennzeichnen die Technische Dokumentation. Außerdem muss sie dem dokumentierten Produkt deutlich zuzuordnen sein, z.B. durch Namens- und Nummernsysteme.
Häufigste Arten von Technischen Dokumentationen sind:
- Bedienungsanleitung*. Beschreibt im Schwerpunkt die Bedienung oder Handhabung eines Produktes. Diese Begriffe werden oft bei technischen Konsumgütern verwendet, z.B. DVD-Player oder Kaffeemaschine. Den gleichen Schwerpunkt verfolgt die Gebrauchsanleitung. Dieser Begriff wird vorwiegend für Verbrauchsartikel wie Medikamente eingesetzt.
- Betriebsanleitung*: Beschreibt im Schwerpunkt den Betrieb eines Produktes. Dieser Begriff wird oft im Maschinen- und Anlagenbau verwendet. Die Betriebsanleitung richtet sich an Fachpersonal. Ähnlich verhält es sich mit der Betriebsanweisung. Der Unterschied ist aber, dass hier der Gesetzgeber den Inhalt vorgibt (Unfallverhütungsvorschriften spielen hier eine große Rolle). Diese Dokumentation richtet sich an die Mitarbeiter eines Unternehmens.
- Benutzerhandbuch: umfangreiches Nachschlagewerk. Diese Art der Dokumentation findet sich oft im Bereich Software und richtet sich an den Endverbraucher. Ein Benutzerhandbuch enthält neben den Informationen zur Bedienung weitere unterstützende Informationen.
- Schulungsmaterialien: Material zur Unterstützung bei Schulungen und Unterricht. Diese Unterlagen sind auf Lehrpläne und Programme abgestimmt. Sie werden zielgerichtet nach pädagogischen und didaktischen Prinzipien aufbereitet. Dazu zählen auch Präsentationen.
- Online-Hilfe: Softwarehandbuch für den Bildschirm. Man unterscheidet zwischen vier Formen: Die Hilfedatei, zu finden im Hilfe-Menü des Programms; die Direkthilfe, die auf Mausklick auf die Hilfeschaltfläche die passende Seite in der Hilfedatei anzeigt; die webbasierte Online-Hilfe im HTML-Format, die im Browser angezeigt wird (besonders bei plattformunabhängigen Anwendungen); das Handbuch im PDF-Format.
- technische Illustrationen: stellen komplexe Sachverhalte verständlich und kurz dar. Die Informationen werden so schneller erfasst und verstanden, das spart einerseits Text und andererseits Zeit. Die Palette reicht von einfachen Strichgrafiken, Infografiken über Diagramme bis hin zu hochwertigen 2D- und 3D-Visualisierung.
* Anweisungen darf nur ein Arbeitgeber an seine Arbeitnehmer weiter geben. Kunden dürfen nur angeleitet werden!
weitere Aufgaben eines Technischen Redakteurs:
- Doku-Check:
- Übersetzungen:
- Druckerzeugnisse:
- Beratung und Konzeption:
- Lektorat
Die Informationen in den Technischen Dokumentationen helfen Ihren Kunden bereits vor dem Kauf – nämlich dann, wenn es um den Nutzen Ihres Produktes geht, dessen Wirkung und Funktion und natürlich dessen Preis.
Nach dem Kauf steht die Dokumentation Ihren Kunden genauso zur Seite – nämlich bei der Einarbeitung, der Bedienung, bei Sicherheitsfragen oder Werterhaltung.
Neben den für Ihre Kunden nützlichen Aspekten wird vom Gesetzgeber das Beilegen von Technische Dokumentationen verlangt, um ein Produkt überhaupt in Verkehr zu bringen.
Diese Frage ist einfach beantwortet. Ihr Entwickler kennt zwar das Gerät genau, kann dies aber meist nur mit seinem Fachvokabular beschreiben. Dies versteht der normale Anwender oft nicht. Daher ist es wichtig, dass es einen kompetenten "Übersetzer" gibt. Der technische Redakteur hat genügend Abstand zum Produkt, um es verständlich beschreiben zu können.
Der Entwickler des Produkts soll sich auch weiter seinen Aufgaben widmen können und keine kostenintensiven Überstunden leisten müssen, um die Dokumentation zu erstellen.
Nein, grundsätzlich arbeiten wir branchenungebunden. Jedoch konzentrieren wir uns auf die Bereiche Automatisierungs-, Mess- und Prüftechnik, Software, Sensortechnik, Hochverfügbarkeit und Konsumgüter.
Ja, wir ermitteln im Rahmen unseres Doku-Checks mögliche Schwachstellen und unterbreiten Ihnen Vorschläge zur Optimierung. Gern unterstützen wir Sie auch dabei, den richtigen Dokumentationsweg für Ihr Unternehmen zu finden. Beauftragen Sie uns mit der Optimierung Ihrer Dokumentation. Der Doku-Check ist für Sie kostenlos.
Selbstverständlich. Wir erarbeiten auf Wunsch vollständige Konzepte, stets auch unter Berücksichtigung Ihres Corporate Designs.
Wir erarbeiten für jedes Projekt ein gesamtheitliches Gesamtkonzept. Wir liefern alle notwendigen Bestandteile: Texte, Grafiken, Zeichnungen und Fotos. Je nach Ihren Bedürfnissen erhalten Sie das fertige Dokument dann als Druckerzeugnis oder als Online-Dokument.
In der Regel ist dies kein Problem. Voraussetzung ist, dass die bestehenden Unterlagen mit professionellen Werkzeugen erstellt wurden. Wir arbeiten mit verschiedenen Text-, Grafik-, Layout- und DTP-Programmen sowie Tools für die Publikation.
Zu unserer hardwareseitigen Ausstattung zählen: PC mit Internet-Anschluss, Laptop für den mobilen Einsatz, Scanner, Drucker, Digitalkamera und externe Festplatten
Zu unserer softwareseitigen Ausstattung zählen: OS Windows XP, MS Office-Paket, OpenOffice-Paket, Adobe Photoshop, Adobe InDesign, Adobe Acrobat, Adobe Technical Communication Suite, Quark Express... Fragen Sie uns an, ob wir auch Ihren Anforderungen gerecht werden können.
Die angegebenen Produkte sind Eigentum der jeweiligen Marken.
Technische Dokumentation ist mehr als nur das einfache Beschreiben von Tätigkeiten zum Umgang mit einem Produkt. Betriebs- und Bedienungsanleitungen müssen verschiedenen Normen und Gesetzen entsprechen.
Wir prüfen Ihre Dokumentation!
Senden Sie uns eine Ihrer Dokumentationen. Wir prüfen diese bezüglich aktueller Normen und Gesetze, Strukturierung und Gestaltung. Anschließend zeigen wir Ihnen das Optimierungspotenzial Ihrer Dokumentation auf, wie z. B. das Einbringen von Symbolen und die klare Strukturierung des Inhalts. Die Ergebnisse präsentieren wir dann in Ihrem Unternehmen.
Eine Aussage zu den Preisen können wir erst nach Abschätzung des Aufwands treffen: Lassen Sie Ihre Technische Dokumentationen bei uns erstellen, klären wir im Vorfeld den Aufwand ab. Dann können wir ein für Sie unverbindliches Angebot erstellen. Nach Ihrer Beauftragung werden die Preise des Angebots verbindlich. Dies bestätigen wir Ihnen dann in unserer Auftragsbestätigung.