Documentar una herramienta de geoprocesamiento personalizada permite a otros usuarios comprender y utilizar la herramienta de forma eficaz. La documentación puede elaborarse en parte utilizando el cuadro de diálogo de propiedades de la herramienta, así como los metadatos de la herramienta.
Propiedades de herramienta
Defina las propiedades que se indican a continuación para documentar la herramienta en el cuadro de diálogo Propiedades. Para abrir el cuadro de diálogo Propiedades, haga clic con el botón derecho en el panel Catálogo.
- En la pestaña lateral General, proporcione una descripción, resumen e ilustración de la herramienta.
- En la pestaña lateral Parámetros, defina una descripción para cada parámetro que aparezca en el cuadro de diálogo de la herramienta al pasar el cursor por encima del botón Información
situado junto a la etiqueta del parámetro.
Metadatos
Para elaborar documentación de ayuda completa para una herramienta, modifique sus metadatos o la descripción del elemento, que contiene los siguientes componentes:
- Titulo: nombre de la herramienta personalizada.
- Imagen miniatura: pequeña imagen que se muestra al pasar el cursor por encima de la herramienta en el panel Catálogo.
- Etiquetas: palabras clave que se utilizan para buscar herramientas en el panel Catálogo o en la vista Catálogo.
- Resumen (extracto): resumen de la tarea que realiza la herramienta, así como algunos casos prácticos. El resumen aparece al pasar el cursor por encima del botón Ayuda
del panel Geoprocesamiento.Nota:
Si el resumen se establece en los metadatos de la herramienta y en el cuadro de diálogo Propiedades, el resumen de las propiedades de las herramientas se mostrará en el cuadro de diálogo de la herramienta.
- Uso: consejos o instrucciones generales sobre cómo utilizar la herramienta de forma correcta y eficaz.
- Sintaxis: ayuda específica para cada parámetro, incluidos tipos y valores de datos aceptables.
En los metadatos también se pueden documentar ejemplos de código, créditos, restricciones de uso y un cuadro delimitador.
Para documentar la herramienta de geoprocesamiento y su caja de herramientas personalizadas, haga clic con el botón derecho en la herramienta o la caja de herramientas y seleccione Editar metadatos. Como alternativa, haga clic con el botón derecho en la herramienta o caja de herramientas, seleccione Ver metadatos y haga clic en el botón Editar 
de la pestaña Catálogo. Cuando haya documentado su herramienta personalizada, cualquier persona que utilice la herramienta podrá obtener la ayuda pertinente del mismo modo que lo hace para las herramientas de geoprocesamiento incluidas en ArcGIS Pro.