Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

This rule checks that every data model has a human-readable description.

Why it matters

A missing description makes it harder for users (humans or machines) to understand the purpose and scope of the data model. The description provides important context about what domain the data model covers, what use cases it supports, and how it should be used.

Example

A data model with ID CIM and name Common Information Model has no description. Users may find it difficult to understand what this data model represents without extra context. A description such as “The Common Information Model (CIM) is a standard developed by IEC for representing power system components and their relationships. It is widely used in the electrical utility industry for data exchange and system modeling.” would greatly improve clarity and usability.

Further reading

Last modified on February 27, 2026