Skip to content

Welcome to the Data Dictionary Hub

Welcome to the central documentation platform for our project's database.

This platform is designed to make our data structure transparent, accessible, and easy to understand for everyone involved in the project—whether you are a developer, a data analyst, or a domain expert.

Our Objectives

The main goals of this data dictionary are:

  • Single Source of Truth: Provide a reliable and standardized reference for all database entities, their attributes, and relationships.
  • Accessibility: Offer a simple, fast, and easily shareable web interface. No complex software installations or database credentials are required to understand our data.
  • Clarity & Context: Go beyond just "data types". Here you will find business definitions, constraints, example values, and specific rules (e.g., geographical data handling) for every single column.
  • Collaborative Maintenance: Empower non-technical team members to keep the documentation alive and updated through a simplified workflow.

How to Navigate

Finding the information you need is quick and straightforward:

  1. Search Bar: Use the powerful search bar at the top of the page. It instantly looks through table names, column definitions, and comments.
  2. Interactive Schema: Start with the Schema Overview (ER) to get a bird's-eye view of how different tables relate to each other.
  3. Table Details: Browse the sidebar navigation menu to dive deep into specific domains and tables. Each page provides an exhaustive breakdown of the selected table.

How to Contribute

Documentation is only useful if it stays up to date. We built this platform so that anyone can contribute, no coding required.

!!! info "Updating the Dictionary via Excel"

You don't need to know Markdown or Git to help out! We manage updates via a simple **Excel template**.

If you need to define a new table or update an existing description, you just need to fill out a spreadsheet containing columns like *Data type, Definition, Example value, etc.*

The technical team will automatically convert your Excel sheet into these web pages. Please read the [Contribution Guidelines](guidelines.md) for more details.

If you find any discrepancies or have questions about specific data entities, please reach out to the database administration team.