Documenter un outil de géotraitement personnalisé

Une des étapes primordiale de la création d'un outil de géotraitement personnalisé consiste à rédiger la documentation d'aide qui permettra aux autres utilisateurs de comprendre et d'utiliser efficacement votre outil.

Vous rédigez la documentation d’aide pour un outil personnalisé en modifiant ses métadonnées ou la description de l’élément qui contient les composants suivants :

• Un résumé de la tâche exécutée par l'outil, ainsi que de brefs exemples de cas d'utilisation
• Des graphiques illustrant les données en entrée dans l’outil et les données produites par ce dernier, ainsi qu’une miniature qui apparaît lorsque l’outil est ajouté à la bibliothèque Analysis (Analyse)
• Des conseils et instructions générales pour utiliser l'outil correctement et efficacement
• De l'aide spécifique sur chaque paramètre de l'outil, y compris des valeurs et types de données acceptables
• Des balises de recherche
• Crédits
• Contraintes d’utilisation, d’accès et légales

Pour documenter votre outil de géotraitement personnalisé et la boîte à outils, vous pouvez cliquer avec le bouton droit sur l’outil ou la boîte à outils, puis sélectionner Edit Metadata (Modifier les métadonnées). Vous avez également la possibilité de cliquer avec le bouton droit sur l’outil ou la boîte à outils, de sélectionner View Metadata (Afficher les métadonnées), puis cliquer sur le bouton Edit (Modifier) sous l’onglet Home (Accueil). Après avoir documenté votre outil personnalisé, quiconque utilise l'outil peut obtenir de l'aide de la même façon qu'avec n'importe quel outil de géotraitement disponible dans ArcGIS.