Skip to main content
Version: 2.9.X

Using Model Doc

Model Doc is a Cogynt feature that compiles and organizes all information contained in a project into a document.

Model Doc serves as a means to generate official documentation for archival or circulation within an organization. (The document can be automatically formatted to be exported as a PDF.) The document is broken down into sections, including:

  • A full table of contents.
  • Print screens of the hierarchical view, patterns, and computations.
  • Detailed configurations and values as provided in Authoring.

Cogynt's self-documenting features can be especially useful when combined with Model Doc. You can improve the readability of both the model and its Model Doc documents by:

  • Creating clear, descriptive names.
  • Filling out description fields with as much relevant information as possible.

When backing up a model, it may be desirable to generate a Model Doc document with each new updated version for easier traceability.