Skip to main content

Documentation Dashboard Overview

The Documentation Dashboard provides visibility into documentation coverage and quality across all data products in a space.

Key Features​

Score Distribution​

Visual breakdown of products by documentation score (Excellent, Good, Fair, Poor) using a donut chart. Click on a segment to filter the product table.

Gap Analysis​

Identifies the most common documentation gaps across products (e.g., missing descriptions, undocumented fields, no owner assigned).

Product Table​

Paginated table of all products with:

  • Documentation score and status badge
  • Gap indicators
  • Direct links to product detail pages

Filtering​

  • Search — filter by product name
  • Tags — filter by product tags
  • Maintenance status — filter by product lifecycle status
  • Sort — sort by score, name, or gap count

Technical Reference​

  • Part of the Analytics & Dashboards module
  • Data sourced from the ProductService.get_documentation_scores() method