ArcGIS for Desktop

  • Documentation
  • Pricing
  • Support

  • My Profile
  • Help
  • Sign Out
ArcGIS for Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS for Desktop

A complete professional GIS

ArcGIS for Server

GIS in your enterprise

ArcGIS for Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Pricing
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

Help

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • More...

Documenting a model

A model and the toolbox in which the model is saved can be documented like any other geoprocessing tool.

  • Right-click a tool or toolbox you created and click Item Description. This will open the Item Description window, displaying the Description page.
  • Click the Edit button Edit Metadata.
  • Enter the description for each category and click the Save button Save Metadata Edits.
Learn more about documenting tools

In addition to the standard documentation you write for your model tool, you can help a user understand your model by making your model diagrams easy to read and follow. Here are some considerations when creating your model:

  • Rename variables and tools so they have context within the model. For example, you might rename the Clip tool to "Cut out study area" or "Find points inside buffer", which give context to how the Clip tool is being used. Likewise, a variable named "Input features" would have more context if renamed to "Input street features dataset".

    Learn more about renaming variables

  • Make the model layout (how elements are arranged) readable.

    Learn more about changing model layout

  • Use element labels and diagram text labels.

    Learn more about labeling a model

  • Use graphics for elements instead of the standard ovals and rectangles.

    Learn more about changing model and element symbology

  • If you have a website that explains your model, or the science behind your model, you can put the weblink in a model label.

    Learn more about showing a URL

  • Expose geoprocessing environments you set in the model as model variables. This way, a user can easily see which environments affect the model.

    Learn more about setting environments using a model variable

  • Export the model as a graphic and use the graphic in the model documentation.

    Learn more about exporting a model as a graphic

Legacy:

The Edit Documentation option that was available from the right-click context menu has been removed at ArcGIS 10.

Feedback on this topic?

ArcGIS for Desktop

  • Home
  • Documentation
  • Pricing
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS for Desktop
  • ArcGIS for Server
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
© Copyright 2016 Environmental Systems Research Institute, Inc. | Privacy | Legal