Dokumentieren von Entwicklerlösungen (FileMaker Pro Advanced)
Sie sollten Dokumentation für Ihre Datenbanklösung zur Verfügung stellen, unabhängig davon, ob die Datenbank in FileMaker Pro oder FileMaker Pro Advanced geöffnet werden muss oder eine eigenständige Runtime-Datenbanklösung darstellt. Es gibt verschiedene Möglichkeiten, eine Dokumentation zu Ihrer Datenbanklösung zu erstellen. Sie können z. B. ein gedrucktes Handbuch, ein Online-Hilfesystem und ein „Info über“-Layout erzeugen, das von jedem
Layout der Lösung aus zugänglich ist.
Erstellen Sie eigene Über- und Hilfe-Layouts, in denen Sie beschreiben, um welche Datenbank es sich handelt, wie sie verwendet wird und wo der Anwender weitere Informationen findet. Verwenden Sie dann die Funktion für angepasste Menüs, um
Scripts mit Menübefehlen zu verknüpfen, die das Über- und das Hilfe-Layout öffnen.
Hinweis Das FileMaker Pro- und das FileMaker Pro Advanced-Hilfesystem sind in Runtime-Anwendungen nicht verfügbar. Die Hilfe auf der Statusleiste (Windows) und Hilfe-Tags (macOS) sind jedoch vorhanden.
Erstellen eines Über-Layouts
Für Runtime-Datenbanklösungen schreibt die FileMaker Pro Advanced-Lizenz die Erstellung eines „Info über”-Layouts vor, damit sich die Anwender an Sie wenden können, wenn sie technische Unterstützung benötigen.
So erstellen Sie ein „Info über“-Layout:
2. Geben Sie als Layoutname Über <Ihre Lösung> ein.
3. Wählen Sie Leeres Layout.
4. Klicken Sie auf Fertigstellen.
5. Fügen Sie Ihr Logo, andere Grafiken und Ihre Firmendaten in das Layout ein.
6. Fügen Sie Text ein, der den Benutzern mitteilt, ob die Lösungsdateien passwortgeschützt sind oder ob Berechtigungen für vollen Zugriff entfernt wurden.
8. Erstellen Sie eine Taste, mit der Ihre Anwender in das Hauptlayout der Primärdatei zurückkehren können.
9. Wählen Sie Scripts > Scriptarbeitsbereich und erstellen Sie ein Script, das in das Layout „Über“ wechselt.
10. Schließen Sie das Wort Über in den Scriptnamen ein.
So zeigen Sie das Layout „Über“ an, wenn die Runtime-Anwendung gestartet wird:
1. Öffnen Sie die Primärdatei der Datenbanklösung.
2. Wählen Sie Datei (Windows) bzw. Ablage (macOS) > Dateioptionen.
3. Wählen Sie in der Registerkarte Öffnen des Dialogfelds „Dateioptionen“ Umschalten zu Layout und wählen Sie das „Info über“-Layout aus der Liste.
Erstellen eines benutzerdefinierten Hilfe-Layouts
Erstellen Sie ein Hilfe-Layout für Anweisungen zur Verwendung Ihrer Lösung und geben Sie entsprechende Daten ein. Erstellen Sie dann ein Script in der Primärdatei Ihrer Lösung, um das Hilfesystem anzuzeigen. Fügen Sie den Scriptnamen mithilfe der Funktion für angepasste Menüs dem Hilfe-Menü hinzu.
Wenn Sie eine Webseite zur Dokumentation Ihrer Lösung erstellen möchten, nehmen Sie einen Web Viewer in Ihr Hilfelayout auf, das die Webseite öffnet.
Gedruckte Dokumentation
Sie müssen den Benutzern Anleitungen für die Installation Ihrer Datenbanklösung zur Verfügung stellen. Sie sollten Folgendes dokumentieren:
•Mindestanforderungen an Hardware und Software
•Wie installieren Sie die gebundene Lösung?
•Wie installieren Sie benutzerdefinierte Dateien?
•Wie verwenden Sie die ggf. mitgelieferte Software für:
•Installation Ihrer Lösung
•Dekomprimierung Ihrer Lösungsdateien
•Wie verwenden Sie das Hilfesystem?
•Wie erhalten Sie technische Unterstützung?
Wichtig Die gedruckte Dokumentation oder eine Textdatei sollte die E-Mail-Adresse oder die Telefonnummer des technischen Kundendienstes enthalten für den Fall, dass die Dateien Ihrer Runtime-Datenbanklösung beschädigt werden. Wenn eine Datenbankdatei beschädigt ist, kann der Anwender unter Umständen nicht mehr auf das Layout „Über“ mit Ihren Kontaktinformationen zugreifen.
Sie können in die Dokumentation auch die folgenden Empfehlungen aufnehmen:
•Raten Sie davon ab, Lösungsdateien umzubenennen (ausgenommen die Runtime-Anwendung). Unter Umständen ist die Lösung sonst nicht mehr lauffähig.
Weiterführende Themen