Market README Template

Every market/KPI folder requires a README.md.

Minimum Required Content

Title

• market name
• KPI name

Purpose

• what this market folder implements

Owner

• named analyst owner
• named product/engineering reviewer if useful

Input Artefacts

• what model artefact is expected
• what raw data is expected
• whether fixed forecast input is required

Market-Specific Assumptions

• week start convention
• date/calendar assumptions
• important transform/decomp quirks

Validation Status

• scaffold only
• partially migrated
• fully migrated and validated

Notes

• known risks
• transition notes from local scripts

Why This Matters

The market README is meant to make the folder understandable without relying on oral context or analyst memory.