PDF-Dokumentation verlinken

Wenn die Installation, der Einbau auf der Anlage oder der Betrieb eines Modells erklärungsbedürftig ist, soll der Konstrukteur eine Dokumentation erstellen, die den Anwender auf möglichst kurzem Weg zum Ziel führt.

Dokumentation schreiben

Schreiben Sie nicht drauf los, sondern versuchen Sie sich in die Perspektive des Anwenders, der das Modell ohne Umstände verwenden will, zu versetzen. Was ist für ihn Voraussetzung, was eher Folklore? Erstellen Sie dann für sich eine Gliederung, die dem Anwender als logische Abfolge von Informationen und Handlungsanweisungen erscheint.

Natürlich haben Sie das Recht, auch kurze allgemeine Erklärungen zum Modell und dessen Vorbild zu verfassen. Bedenken Sie aber, dass der Anwender bei Bedarf fast alles im Netz nachrecherchieren kann, wenn es ihn überhaupt interessiert. So ist eine allgemeine Geschichte der Bahnschranke ebenso überflüssig wie detailverliebte Schilderungen einer bestimmten Dorfkirche.

Umso wichtiger ist es, dass Sie die Funktionsweise von Modellen mit komplexen Bewegungsachsen erläutern. Ebenso essenziell ist die genaue, möglichst bebilderte Erklärung der Handhabung von Gleisobjekten, wenn sie als Set mit zueinander passenden Elementen vorliegen.

Die Dokumentation ist oft der erste Eindruck, den der Anwender vom gerade erworbenen Modell gewinnt. Da die Dokumentation auch schon vor dem Kauf im Shop präsentiert wird, gehört sie so auch zur Visitenkarte des Modells überhaupt. Schreiben Sie daher die Dokumentation möglichst in einer Textverarbeitung mit Rechtschreibhilfe. Zudem: Nicht jedem ist flüssiges Formulieren in die Wiege gelegt. Hier helfen – nicht anders als bei technischen Fragen beim Arbeiten mit dem Home-Nostruktor – im schriftlichen Ausdruck erfahrene Kollegen gerne weiter.

Schließlich wird der Text als PDF exportiert (das ermöglichen praktisch alle Office- bzw. Textverarbeitungsprogramme). Als Qualitätsstufe reicht die Mittlere; der Anwender wird die Dokumentation in aller Regel am Bildschirm lesen. Das hält die Datei schlank.

PDF-Dokumentation in der externen *.ini-Datei eintragen

Der folgende Absatz bedarf weiterer Recherchen! Das Modell kann in der externen *.ini-Datei mit insgesamt vier PDF-Dokumenten in den Sprachen Englisch, Deutsch, Französisch und Polnisch verlinkt werden. Dies ermöglicht dem Anwender, die Dokumentation direkt aus der Modell-Auswahlliste aufzurufen. Dies ist nicht nur für die Programm-Ergonomie vom Vorteil, vielmehr spart es auch Zeit (und unter Umständen auch Nerven), sollten sich bereits zig PDF-Dokumente angesammelt haben und die Suche nach dem Passenden zunehmend schwieriger wird.

Die PDF-Dokumentation, welche grundsätzlich aus dem \Resourcen\Doc\-Ordner aufgerufen wird (EEP durchsucht diesen Ordner nach PDF-Dateien automatisch), kann in der externen *.ini-Datei wie folgt verknüpft werden:

PdfDoc_ENG = "Anleitung_zum_Modell_XYZ_ENG.pdf"
PdfDoc_GER = "Anleitung_zum_Modell_XYZ_DEU.pdf"
PdfDoc_FRA = "Anleitung_zum_Modell_XYZ_FRA.pdf"
PdfDoc_POL = "Anleitung_zum_Modell_XYZ_POL.pdf"

Bis auf den vollständigen Dateinamen mit der Endung *.pdfsind als alphanumerische Werte keine weiteren Pfadangaben notwendig, es sei denn, die Datei befindet sich im Unterordner des Zielordners \Doc\. Stehen außer einer deutschsprachigen Anleitung keine weiteren Sprachversionen zur Verfügung, soll auf leere Werte, etwa: PdfDoc_POL = "" - komplett verzichtet werden, denn; was nicht da ist, braucht auch nicht initialisiert zu werden.

PDF-Dokumentation in der Installationsdatei eintragen

Wenn die Dokumentation im Ordner Resourcen\Doc liegen soll, sieht die Installationsdatei z.B. so aus:

File001 = []
...
File015  = "V80NHW10019.pdf","Resourcen\Doc\V80NHW10019.pdf"

Das setzt voraus, dass sich die PDF-Datei im Installationspaket befindet. Siehe hierzu auch das Beispiel einer externen Ini-Datei.

Zur Startseite