Ein wichtiger Teil in Bezug auf die Erstellung eines benutzerdefinierten Geoverarbeitungswerkzeugs besteht darin, eine Hilfedokumentation zu schreiben, damit andere Ihr Werkzeug verstehen und effizient verwenden können.
Beim Verfassen der Hilfedokumentation für ein benutzerdefiniertes Werkzeug ändern Sie dessen Metadaten bzw. Elementbeschreibung, wozu folgende Angaben zählen:
- Eine Zusammenfassung des Tasks, der von Ihrem Werkzeug ausgeführt wird, sowie kurze Anwendungsfälle
- Grafiken, die Ihre Werkzeugeingaben und -ausgaben oder die Funktionsweise Ihres Werkzeugs veranschaulichen, und eine Miniaturansicht, die angezeigt wird, wenn das Werkzeug zur Galerie Analyse hinzugefügt wird.
- Allgemeine Tipps oder Anweisungen zur richtigen und effizienten Verwendung des Werkzeugs
- Spezifische Hilfe für jeden Werkzeugparameter, einschließlich zulässiger Datentypen und Werte
- Such-Tags
- Quellennachweise
- Rechtliche Einschränkungen, Zugriffs- und Nutzungsbeschränkungen
Um Ihr benutzerdefiniertes Geoverarbeitungswerkzeug und die Toolbox zu dokumentieren, können Sie mit der rechten Maustaste auf das Werkzeug oder die Toolbox klicken und Metadaten bearbeiten auswählen. Alternativ können Sie mit der rechten Maustaste auf das Werkzeug oder die Toolbox klicken, Metadaten anzeigen auswählen und auf die Schaltfläche Bearbeiten auf der Registerkarte Start klicken. Nachdem Sie Ihr benutzerdefiniertes Werkzeug vollständig dokumentiert haben, kann jeder, der das Werkzeug verwendet, die Hilfe auf dieselbe Weise abrufen wie für die in ArcGIS integrierten Geoverarbeitungswerkzeuge.