Übersicht

Die Maschinenrichtlinie schreibt vor, dass mit jeder Maschine eine Dokumentation ausgeliefert werden muss und auch das Produktsicherheitsgesetz fordert eine Bedienungsanleitung für verkaufte Produkte. Durch diese gesetzlichen Vorgaben ist die Dokumentation von Maschinen und Produkten heute für jedes Unternehmen notwendig. Dabei kostet die Dokumentation Zeit, muss konsistent sein und soll immer gleich aussehen, auch wenn mehrere Personen an ihr arbeiten.

TwinCAT Documentation Generation ermöglicht die Anfertigung von Dokumentation innerhalb einer Maschinenanwendung oder SPS-Bibliothek. Dafür verwendet das Programm spezifische Markups innerhalb der Quellcode-Kommentare, um relevante Informationen zu markieren und für die Dokumentation zu formatieren. Auch der Verweis auf andere Dokumente, die zusätzliche Informationen enthalten, ist möglich.

Da die Dokumentation direkt aus der Programmierung generiert wird, kann sichergestellt werden, dass das Anwendungsprogramm und die Dokumentation konsistent sind. Zudem ist der zusätzliche Aufwand für die Entwickler moderat, weil die Generierung der Dokumentation auf der Basis von Markups erfolgt. Die Entwickler können in TwinCAT Documentation Generation Inhalte zur Dokumentation beitragen, ohne mit den typischen Autorenwerkzeugen vertraut zu sein.