Bevor ein Produkt verkauft bzw. zum Einsatz kommen kann, müssen viele Informationen und Daten gesammelt und zusammengetragen werden. Interne Dokumente können z. B. sein: Technische Zeichnungen Risikobeurteilung Pflichtenheft Zertifikate und Prüfberichte Material- und Stücklisten
Sicherheitshinweise, Warnhinweise, Gefahrenhinweise – Häufig tauchen diese Begriffe in der Technischen Dokumentation als Synonyme auf. Dabei haben sie unterschiedliche Bedeutungen. Doch wo liegt jetzt der Unterschied? Sicherheitshinweise beschreiben dem Nutzer alle wesentlichen Aspekte zum sicheren Umgang mit dem Produkt und stehen häufig in einem eigenen Sicherheitskapitel. Sie dienen als Grundlage für eine Einweisung oder Schulung … Weiterlesen
Publizieren und Layouten sind die letzten Schritte im Erstellungsprozess. Hier kommen die Module zusammen und werden zu einer kompletten Dokumentation aufbereitet. Sind das z. B. Word Dokumente, kommt es oft zu unerwünschten Effekten, wenn Dokumente zusammenkopiert werden. Beim Maschinenbau müssen oft für die Zulieferdokumente Inhaltsverzeichnisse erstellt werden, zumeist manuell. Für diese Schritte ist Zeit erforderlich, … Weiterlesen
Die Verwaltung von Dokumentationen erfolgt vielfach auf dem Dateisystem, teilweise ergänzt mit einer Excel-Tabelle. Dies ist aufwendig, umständlich und fehlerträchtig. Stand der Technik ist für die Technische Dokumentation ein spezialisiertes Redaktionssystem zu nutzen, sogenannte CMS oder CCMS System, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.
Beim Texten muss systematisch gearbeitet werden. Technische Dokumentation muss modular aufgebaut sein, d. h. aus Modulen bestehen, die in unterschiedlichen Dokumentationen wieder verwendet werden können. Dabei darf nicht jeder Redakteur seinen eigenen Stil und seine eigene Modularisierungsweise entwickeln. Einheitlichkeit ist hier notwendig. Dies geht am besten methodisch, siehe https://arakanga.de/arawiki/strukturierungsmethoden/. Bei der Grafikerstellung kann vielfach auf 3d_Daten … Weiterlesen
Bei der Informationsrecherche geht viel Zeit verloren, wenn bei der Produktentwicklung nicht an die Informationsbedürfnisse der Redakteure gedacht wird. Die Dokumentation muss in den Entwicklungsprozess integriert werden und alle notwendigen Informationen automatisch erhalten. Stellen Sie hierzu eine Liste auf, welche Informationen die Redaktion benötigt. Definieren Sie, wer für die Lieferung der jeweiligen Info verantwortlich ist … Weiterlesen
Kosten entstehen in der Dokumentation an verschiedenen Stellen: Kosten sparen bei der Informationsrecherche Kosten sparen beim Texten und Grafikerstellen Kosten sparen bei der Verwaltung Kosten sparen beim Publizieren, Layouten Kosten sparen beim Übersetzen In jedem Bereich lassen sich Kosten sparen. Wenn die Bereiche optimal aufeinander abgestimmt sind, ist der Sparerfolg am größten
Technische Redakteure sind speziell ausgebildete und qualifizierte Fachkräfte, die technische Daten/Informationen in verständlicher Sprache vermitteln. Der Technische Redakteur erstellt beispielsweise folgende technische Dokumente: Montage- und Wartungsanleitungen Bedienungsanleitungen Gebrauchsanweisungen Onlinehilfen für Softwareprodukte Nutzungsinformationen Usw.
Liefern Sie als Hersteller Ihre Produkte in unterschiedlichen Varianten in mehrere Länder? Falls ja, dann ist ein Redaktionssystem mit einem effizienten Variantenmanagement sicher sinnvoll für Ihre Dokumentation! Warum? Sie haben mit Sicherheit etliche redundante Inhalte, die ziemlich ähnlich oder fast identisch sind. Diese müssen bei einer Aktualisierung alle einzeln angefasst werden. Das kostet Zeit und … Weiterlesen