Обеспечить сервис и задачи хорошей документацией крайне важно, если вы стремитесь, чтобы сервис был доступен и понятен максимально широкой аудитории.
Документирование надо начинать с инструмента, который создал публикуемый результат. Каждый инструмент в системе имеет описание элемента, которое можно просматривать и редактировать, щелкнув инструмент правой кнопкой мыши в окне Каталог и выбрав Описание элемента.
Невозможно изменить описание элемента применительно к системным инструментам. Если задача основана на системном инструменте, как в примере использования инструмента Построить таблицу соседних объектов (Generate Near Table) в разделе Краткий обзор создания сервисов геообработки, можно только изменить документацию задачи в редакторе сервисов.
Более подробно об описании элементов и документировании инструментов
Редактирование документации в редакторе сервисов
При предоставлении общего доступа к результатам как к сервису геообработки редактор сервисов считывает описание элемента применительно к инструменту, с помощью которого был создан результат.
Примечание:
Описание сервиса инициализируется с использованием описания инструмента, с помощью которого был создан результат. В редакторе сервисов необходимо тщательно просмотреть это исходное описание элемента, так как оно содержит описание задачи в рамках сервиса, а не самого сервиса. Это особенно важно, если в сервисе имеется несколько задач.
Сервис содержит описание элемента, как показано ниже. Это описание элемента содержит общие сведения, теги и описание. Общие сведения необходимы при предоставлении общего доступа к сервису на arcgis.com. Длина не должна превышать 250 символов. Описание по длине не ограничено.
Отдельная задача в рамках сервиса также имеет обязательное описание, как показано ниже.
Наконец, отдельные параметры задачи содержат обязательное описание, как показано ниже.
