Utilisation de FileMaker Pro Advanced > Paramétrage de fichiers pour les solutions de développement (FileMaker Pro Advanced) > Documentation de solutions de développement (FileMaker Pro Advanced)
 
Documentation de solutions de développement (FileMaker Pro Advanced)
Qu'il s'agisse d'une base de données à ouvrir dans FileMaker Pro, FileMaker Pro Advanced ou une solution d'exécution autonome, il est préférable d'accompagner votre solution d'une documentation. Divers moyens vous permettent de générer une documentation pour votre solution, y compris un manuel imprimé, un système d'Aide en ligne ou un modèle À propos de accessible depuis tous les modèles de l'application.
Vous pouvez créer des modèles personnalisés A propos de et Aide présentant votre solution, son utilisation et des liens vers des informations complémentaires. Utilisez ensuite la fonction de menus personnalisés pour lier des scripts aux commandes de menu qui ouvriront ces modèles.
Remarque  Les systèmes d'aide en ligne de FileMaker Pro et FileMaker Pro Advanced ne sont pas disponibles dans les applications d'exécution. Néanmoins, l'aide de la barre d'état (Windows) et les balises d'aide (macOS) restent disponibles.
Création d'un modèle A propos de
Pour les solutions d'exécution, le contrat de licence FileMaker Pro  Advanced précise que vous devez créer un modèle A propos de indiquant aux utilisateurs les modalités d'accès à l'assistance technique.
Pour créer un modèle A propos de:
1. En mode Modèle, cliquez sur Nouveau modèle/rapport dans la barre d'outils.
2. Dans la zone du nom du modèle, tapez <A propos de votre solution>.
Important  Pour les solutions d'exécution, les mots A propos de doivent figurer dans le nom du modèle. Vous devez également inclure certaines informations particulières dans le modèle. Consultez la section Vos responsabilités de développeur (FileMaker Pro Advanced).
3. Sélectionnez Modèle vierge.
4. Cliquez sur Terminer.
5. Incluez votre logo, la présentation de votre société et d'autres graphiques si nécessaire.
6. Ajoutez un texte précisant aux utilisateurs que les fichiers de la solution sont protégés par des mots de passe ou que les privilèges Accès intégral ont été supprimés.
7. Pour plus de détails sur la formulation exacte des contraintes légales, consultez la section Vos responsabilités de développeur (FileMaker Pro Advanced).
8. Créez un bouton qui permettra aux utilisateurs de revenir au modèle du fichier principal.
9. Sélectionnez le menu Scripts > Espace de travail de script et créez un script destiné au modèle A propos de.
10. Vous devez inclure le terme A propos de dans le nom du script.
11. Créez une commande de menu affichant le modèle A propos de. Consultez la section Définition de menus personnalisés (FileMaker Pro Advanced).
Pour afficher le modèle A propos de au démarrage de l'application d'exécution :
1. Ouvrez le fichier principal de la solution.
2. Sélectionnez le menu Fichier > Options de fichier.
3. Dans l'onglet Ouvrir de la boîte de dialogue Options de fichier, sélectionnez Activer le modèle, puis choisissez le modèle A propos de dans la liste.
Création d’un modèle d’Aide personnalisé
Créez un modèle d'Aide décrivant l'utilisation et la saisie de données dans votre solution. Dans le fichier principal de votre solution, créez alors un script permettant d'afficher ce système d'Aide. Pour que ce script soit disponible sous la forme d'une commande du menu Aide, servez-vous de la fonction Menus personnalisés.
Si vous souhaitez créer une page Web pour documenter votre solution, vous pouvez ajouter un Web Viewer à votre modèle d'aide permettant d'afficher la page Web.
Consultez la section Création et modification d'éléments de menu personnalisés (FileMaker Pro Advanced).
Ajout d'une documentation papier
Vous devez fournir aux utilisateurs des instructions sur les modalités d'installation de votre solution de base de données. Voici une liste des éléments devant figurer dans cette documentation :
Configuration matérielle et logicielle minimale requise
Modalités d'installation de votre solution
Modalités d'installation des fichiers personnalisés
Modalités d'utilisation du logiciel que vous avez inclus pour :
installer votre solution ;
décompresser vos fichiers de solution.
Modalités de mise à jour des fichiers de la solution (voir Importation de données dans des solutions d'exécution mises à jour (FileMaker Pro Advanced))
Modalités d'utilisation du système d'Aide
Modalités de démarrage de l'application (voir Démarrage de solutions d'exécution (FileMaker Pro Advanced))
Procédure à suivre lorsque des fichiers sont endommagés (voir Récupération des fichiers d'exécution (FileMaker Pro Advanced))
Comment contacter l'assistance technique
Important  Si les fichiers de votre solution d'exécution sont endommagés, veillez à ce que les utilisateurs disposent des coordonnées de votre assistance technique dans la documentation imprimée ou dans un fichier texte car ils ne pourront probablement pas accéder au modèle A propos de pour afficher vos coordonnées.
Vous pouvez également ajouter les recommandations suivantes :
Indiquez aux utilisateurs que s'ils renomment les fichiers de la solution (à l'exception de celui de l'application d'exécution elle-même), cela peut nuire à son bon fonctionnement.
Recommandez des sauvegardes régulières des données. Une partie de la procédure peut être automatisée en ajoutant des scripts réalisant des copies des fichiers. Consultez la section Maintenance et récupération de bases de données FileMaker Pro.
Rubriques connexes 
A propos de la création de solutions d'exécution (FileMaker Pro Advanced)
Préparation de fichiers pour une solution d'exécution (FileMaker Pro Advanced)
Liaison de fichiers dans une solution d'exécution (FileMaker Pro Advanced)
Attribution de noms aux solutions d'exécution (FileMaker Pro Advanced)