Для создания качественного инструмента геообработки важно написать документацию, которая позволит другим пользователям понять принцип работы вашего инструмента и эффективно его применять.
Следует написать справочную документацию для такого инструмента, изменив его метаданные, либо описание элемента, которое состоит из следующих компонентов.
- Общая информация о задаче, которую решает инструмент, а также примеры использования
- На рисунках показываются входные и выходные параметры инструмента, либо принцип его работы, а также значок, который будет отображаться, когда инструмент будет добавляться в галерею Анализ
- Основные подсказки или инструкции по корректному и эффективному использованию инструмента
- Специальная справка по каждому параметру инструмента, включая подходящие типы данных и значения
- Теги поиска
- Авторы
- Правовые ограничения, ограничения доступа и использования
Для документирования пользовательского инструмента геообработки или набора инструментов можно щелкнуть правой кнопкой мыши и выбрать Редактировать метаданные. Либо можно щелкнуть на них правой кнопкой мыши, выбрать Просмотр метаданных и затем нажать кнопку Редактировать на вкладке Главная. После того, как вся информация об инструменте будет заполнена, любой пользователь этого инструмента сможет посмотреть справку о нем, как и о любом другом стандартном инструменте ArcGIS.