Regelwerke und Hinweise für offizielle Konstrukteure

Dokumentation schreiben und 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.

Der Dateiname der Dokumentation kann, muss aber nicht dem des Modells entsprechen. Die Dokumentation zum Modell BR_01_150_DB_ZZ1.3dm kann BR_01_150_DB_ZZ1.pdf oder z.B. Lok_01_150_Wittebleche.pdf heißen. Es gelten die üblichen Konventionen für Dateinamen.

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

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. Auf diese Weise findet der Anwender die Dokumentation am schnellsten, zumal die Dateinamen im Ablage-Ordner der PDF-Dokumente nicht immer auf Anhieb verständlich sind.

Mausklick rechts auf die Modellbezeichnung öffnet ein Kontextmenü Hier kann die Dokumentation, soweit vorhanden, ausgewählt werden.

Damit die Verlinkung gelingt, wird sie in der externen *.ini-Datei so eingetragen:

PdfDoc_ENG = "Doku_zum_Modell_XYZ_ENG.pdf"<br>
PdfDoc_GER = "Doku_zum_Modell_XYZ_DEU.pdf"<br>
PdfDoc_FRA = "Doku_zum_Modell_XYZ_FRA.pdf"<br>
PdfDoc_POL = "Doku_zum_Modell_XYZ_POL.pdf"<br>

Bis auf den vollständigen Dateinamen mit der Endung *.pdf sind keine weiteren Pfadangaben notwendig, es sei denn, die Datei befindet sich im Unterordner des Zielordners \Doc\. Liegt die Dokumentation in nur einer Sprachversion vor (was die Regel sein dürfte), soll auf leere Werte, etwa: PdfDoc_POL = "" , verzichtet werden.

PDF-Dokumentation in der Installationsdatei eintragen

Im Gegensatz zum Eintrag in der *.ini-Datei wird im Installationsskript der Pfad ab dem Ordner Resourcen aufgeführt. 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.

Modell zum Signieren hochladen

Ihre fertigen Modelle, die den Prozess der Modellinstallation durchlaufen haben, übergeben Sie an das Tester-Gremium des Trend Verlags. Dies gilt für Shop- wie für Free-Modelle. Nach eventuellen Nachbesserungen, zu denen Sie das Tester-Gremium auffordern wird, wird das Modell vom Trend Verlag signiert und demnächst in den Shop eingestellt.

Flight Check

Sie ersparen sich und den Testern Zeit und Kraft, wenn Sie vor der Bereitstellung des Modells diese Liste durchgehen:

• Backface Culling (ToDo)?
• ToDo
• Beträgt die Länge der Dateinamen einschließlich Punkt und Endung maximal 31 Zeichen?
• Enthalten die Dateinamen nur die erlaubten Zeichen?
• Läuft eine Probe-Installation auf ihrem eigenen Rechner ohne Fehlermeldungen?
• Starten Sie die DEV-Version von EEP. Legen Sie eine leere Anlage an. Platzieren Sie das soeben installierte Modell. Sehen Sie das Modell komplett und fehlerfrei?
• Haben Sie das Modell mit einer Dokumentation versehen, sie in der externen *.ini-Datei verlinkt und beigepackt?

Vortest

Wenn Sie Ihrem Modell grünes Licht geben können, übergeben Sie es nach Möglichkeit zu einem inoffiziellen Vortest an einen befreundeten Konstrukteurskollegen oder anderen Fachmann. So lassen sich niederschwellig Fehler korrigieren und verschiedene Einschätzungen zum Modell diskutieren.

Modell an Tester-Gremium hochladen

Spätere Updates

Sound in Immobilien

Es empfiehlt sich, dem Anwender die Sound-Steuerung über Kontaktpunkte zu dokumentieren, damit er nicht in die Falle tappt und im Planfenster fälschlich Kontaktpunkte für Sound auswählt.

Zurück zum Kapitel Sound in Immobilien.