Archive: FAQs

Was ist iiRDS und welchen Nutzen hat iiRDS für ein Content Delivery Portal?

IiRDS steht für „International Standard for intelligent information Request and Delivery“ und ist ein Standard, der für die Bereitstellung intelligenter Informationen entwickelt wurde. Das Ziel mit dieser Methode ist es, die benötigten Informationen im spezifischen Kontext, zur gewünschten Zeit, individualisiert und auf bestimmen Endgeräten bereitzustellen. Genau das, was ein Content-Delivery-Portal leisten sollte. Im Grunde ist … Weiterlesen

Wie kann ich Inhalte für ein Redaktionssystem mit iiRDS-Metadaten versehen?

Eine Möglichkeit Inhalte mit iiRDS-Metadaten zu versehen ist über die Nutzung des iiRDS Open Toolkits möglich. Das iiRDS Open Toolkit ist kostenfrei über die Website www.iirds.org aufrufbar. Dort können Inhalte (Dateien) wie zum Beispiel HTML-, PDF- und XML-Dateien hochgeladen werden.Im Anschluss können zu den hochgeladenen Inhalten iiRDS-Metadaten über eine Drop-Down-Liste mit definierten Werten vergeben werden. Es gibt … Weiterlesen

Sicherheitshinweis vs. Warnhinweis in der Technischen Dokumentation – Was ist der Unterschied?

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

Wie können Kosten beim Publizieren und Layouten in der Technischen Dokumentation gespart werden?

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

Wie können Kosten bei der Verwaltung in der Technischen Dokumentation gespart werden?

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/.

Wie können Kosten beim Texten und der Grafikerstellung in der Technischen Dokumentation gespart werden?

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

Wie können Kosten bei der Informationsrecherche in der Technischen Dokumentation gespart werden?

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

Wie können in der Technischen Dokumentation Kosten gespart werden?

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

Sind Verweise auf die Lieferantendokumentation / Herstellerdokumentation in der Betriebsanleitung ausreichend?

Vor allem die Kapitel „Wartung“ und „Instandsetzung“ sind oftmals mit Verweisen auf die Herstellerdokumentation versehen. Das muss auch so sein, denn der Maschinenhersteller ist nach der Maschinenrichtlinie für die „Gesamtheit“ der ausgelieferten Maschine verantwortlich. Doch ist ein Verweis auf eine auszuführende Tätigkeit dafür ausreichend? Gemäß der DIN EN ISO 20607 ist das richtig, aber es … Weiterlesen

Kann eine Betriebsanleitung in mehrere Handbücher aufgeteilt werden?

Es kann in der Praxis durchaus vorkommen, dass es sinnvoll ist, eine Betriebsanleitung in einzelne Handbücher aufzuteilen. Somit bleibt eine komplexe und umfangreiche Dokumentation übersichtlich. Teilen Sie die Inhalte der Handbücher zielgruppengerecht auf. Beispielsweise enthält ein Montagehandbuch nur die Inhalte der Montage und das Wartungshandbuch die Inhalte zur Wartung und Instandsetzung. Achten Sie darauf, dass … Weiterlesen