Dokumentation und Online-Hilfe
bei Simulationssoftware von RP Photonics
Hochwertige Dokumentation ist ein Bestandteil jeder guten Modellierung- und Designsoftware. Solche Software soll schließlich für mehr oder weniger komplizierte Dinge eingesetzt werden, und es wäre nicht akzeptabel, dass Benutzer viel Zeit einsetzen müssen, um herauszufinden, wie solche Software funktioniert.
Eine solche Dokumentation muss viele Aspekte abdecken:
- Sie muss die Prinzipien des verwendeten physikalischen Modells klar verständlich erklären, ebenfalls die gemachten Annahmen und verwendete Approximationen, berücksichtigte physikalische Effekte, etc.
- Sie erklärt die Benutzeroberfläche, sodass Benutzer die Software auf möglichst praktische Weise handhaben können.
- Wenn eine Skriptsprache angeboten wird, müssen deren Eigenschaften detailliert erklärt werden.
- Die Dokumentation gibt einen Überblick über die gelieferten Dateien, beispielsweise einschließlich der gelieferten Demo-Dateien.
- Zusätzlich zu den einführenden Erklärungen sollte es für manche Aspekte (beispielsweise für mathematische Funktionen) eine Referenz für einfaches Nachschlagen geben.
Beachten Sie, dass die Erstellung hochwertiger Dokumentation hoch entwickelte didaktische Fähigkeiten voraussetzt, die nicht jeder Programmierer hat. Der Entwickler unserer Software, Dr. Paschotta, verfügt in diesem Gebiet über eine umfangreiche Erfahrung.
Alle Softwareprodukte von RP Photonics enthalten ein umfangreiches PDF-Handbuch. (Als ein Beispiel können Sie den Anfang des Manuals von RP Fiber Power mit dem Inhaltsverzeichnis herunterladen.) Zusätzlich haben die Produkte RP Fiber Power, RP Resonator and RP Coating ein umfangreiches kontextsensitives Online-Hilfesystem (siehe den Screenshot unten als Beispiel).
Natürlich können alle verbleibenden Fragen mit Hilfe des technischen Supports geklärt werden.