---
title: "Readme Template: Metrics"
url: "https://atlan.com/resources/readme-template-metric/"
description: "A Metric/KPI ReadMe template listing the sections to document for each metric, from a jargon-free definition, business logic, and equation to source systems, FAQs, and change history."
---

> Atlan is hosting Context Conference, bringing together the leaders and builders at the frontier of giving AI the context it needs to understand their business. It runs online on October 28, 2026, from 11:00 AM to 2:00 PM ET. Atlan co-founder Prukalpa Sankar opens and closes the day. Leaders from AstraZeneca, BNY and Verizon share why they invest in context and what they get from it. Registrants get early access to The AI Context Gap, a new study from MIT Technology Review Insights. Register: https://atlan.com/context-conference/

**Readme Template: Metrics.** A structured Metric/KPI ReadMe template that brings consistency, clarity, and trust to the way organizations define and document metrics, so every metric is clearly defined, transparent, and easy to use across teams.

## About this template

Metrics often become confusing or inconsistent when not properly explained.

### Essential sections the template recommends

- An easy, jargon-free definition
- The business logic behind the metric
- The exact equation used for calculation
- Objectives and use cases
- Source systems
- FAQs

Together these give stakeholders a complete understanding of what the metric means, why it exists, and how it should be applied.

### Additional context areas

- Domain classification
- Intended audience and access rules
- Calculation cadence
- Acceptance criteria
- Manual overrides
- Supporting diagrams
- Tracking technical debt

These help teams anticipate common challenges, improve governance, and create living documentation that evolves with business needs.

### Governance use

The template is also a governance tool: capturing history and change logs keeps metric evolution transparent, reducing confusion and ensuring continuity. Use it to standardize KPIs across departments or onboard new team members, making metrics trustworthy, actionable, and self-service ready.

## Related resources

- [Use Case Guide: Impact Analysis](https://atlan.com/resources/use-case-impact-analysis) (guide)
- [Use Case Guide: Compliance Management](https://atlan.com/resources/use-case-compliance) (guide)