- Name:
e.g. "Active Case Listings", "Probation Orders Issued" - Owning Domain / Department:
e.g. Listing Service Team, Probation Service - Product Owner:
Name + contact – responsible for the data product’s upkeep - Purpose / Business Context:
Short paragraph explaining why this data exists and how it can be used
- Interface Type:
e.g. REST API, SQL Table, S3/Blob Path, GraphQL, Pub/Sub topic - Access Mechanism:
e.g. URL, connection string, auth method, IAM role, API key - Schema / Contract Location:
Link to JSON Schema, OpenAPI spec, Parquet schema definition, etc. - Versioning Strategy:
How are changes handled – breaking vs non-breaking, deprecation policy
- Data Format:
e.g. JSON, CSV, Parquet, Avro - Update Frequency:
e.g. real-time, daily batch, monthly snapshot - Latency / Freshness Expectations:
e.g. available within 2 hours of event - Retention Period:
e.g. 90 days, 1 year, indefinite - Quality Expectations / SLAs:
Optional – % completeness, null rates, timeliness
- Data Dictionary / Field Descriptions:
Link or inline – describe each key field - Known Caveats or Data Gaps:
Are there known issues or things consumers should be aware of? - Consumer Onboarding Guide:
Steps for a new team to access and use the data
- Data Classification / Sensitivity:
e.g. Public, Internal, Official-Sensitive, etc. - Access Policy:
Who can request access, approval process if any - Audit Logging (if any):
Are accesses logged? How long are logs retained?
- Support Channel:
e.g. Slack channel, email address, JIRA board - Change Request Process:
How do consumers request new fields or changes?