Markdown Editor

Data Requirements Specification Template

Entities, data dictionary, quality targets, retention, privacy basis, lineage, data interfaces, migration, ERD

Yêu cầu & Phân tíchChuẩndatamath
Mở trong editorTải .md

Cách dùng: Use it when a system's data must be defined, owned and governed before design or migration. List entities with owners and the business questions first. The main pitfall is quality requirements with no measurable target or measurement method.

Xem trước

Data Requirements Specification: [System or data product name]

Data requirements specification describing the data a system must capture, hold, exchange and dispose of: entities, a data dictionary, quality targets, retention, privacy classification, lineage, interfaces and migration. Based on common industry practice in data management and business analysis. Replace every [bracketed] value and every row marked Example.

FieldValue
Document ID[DRS-SYSTEM-001]
System / data product[Name] [release]
Version[0.1]
Status[Draft / In review / Approved]
Owner[@data-owner]
Data steward[@data-steward]
Privacy reviewer[@privacy-officer]
Last updatedYYYY-MM-DD
Related documents[SRS], [Database design], [DPIA], [Data dictionary]

1. Purpose and scope

This specification defines the data requirements for [System name]. It covers the data domains [customer, orders, products] used by the processes [order capture, fulfilment, invoicing]. Out of scope: [data warehouse models, which are specified in DRS-DW-xxx].

Business questions the data must answer:

  • Example: How many orders were placed per channel per day?
  • Example: Which customers have open orders older than 5 days?
  • [Question]

2. Data entities and definitions

EntityDefinition (one record represents)OwnerStewardVolumeGrowth
Example: CustomerA person or organisation that has placed or may place an orderHead of SalesCRM team1.2 M8% / year
Example: OrderA confirmed request from one customer to buy one or more productsHead of OperationsOrder team4 M / year15% / year
Example: Order lineOne product and quantity within an orderHead of OperationsOrder team11 M / year15% / year
Example: ProductAn item offered for sale, at SKU levelHead of MerchandisingCatalogue team40,0005% / year
[Entity][Definition][Role][Team][n][Rate]

The entity relationships are shown below.

3. Data dictionary

EntityFieldTypeLengthFormat / allowed valuesMandatoryValidationSourceOwnerClassification
Customercustomer_idString12C + 11 digitsYesUnique; system generatedSystemSalesInternal
CustomeremailString254RFC 5322 addressYesSyntax check; verified by linkCustomerSalesPersonal
Customerdate_of_birthDate10YYYY-MM-DDNoAge 16 to 120CustomerSalesPersonal
Customercountry_codeString2ISO 3166-1 alpha-2YesIn code listCustomerSalesInternal
Orderorder_idString14ORD- + 10 digitsYesUniqueSystemOperationsInternal
Orderplaced_atTimestampn/aISO 8601, UTCYesNot in futureSystemOperationsInternal
OrderstatusEnum20Placed, Paid, Shipped, Delivered, CancelledYesValid transition onlySystemOperationsInternal
Order linequantityIntegern/a1 to 999YesPositive integerCustomerOperationsInternal
Order lineunit_priceDecimal12,2Currency of orderYesAt or above 0CatalogueMerchandisingInternal
[Entity][field][Type][n][Format][Yes / No][Rule][Source][Owner][Public / Internal / Personal / Sensitive personal / Confidential]

4. Data quality requirements

IDDimensionRuleTargetMeasurementFrequencyAction when breached
DQ-01AccuracyCustomer postal address matches the postal reference file98%Address validation reportWeeklySteward reviews failures
DQ-02CompletenessMandatory fields populated on Order100%Null count queryDailyBlock load; alert team
DQ-03CompletenessCustomer phone number present85%Null ratioMonthlyPrompt at next login
DQ-04TimelinessOrder visible in reporting after placementWithin 15 min for 99%Lag metricContinuousIncident if over 1 h
DQ-05ConsistencyOrder total equals sum of lines plus tax and shipping100%Reconciliation jobDailyQuarantine record
DQ-06UniquenessNo duplicate customers by verified email99.5%Duplicate match reportMonthlyMerge process
DQ-07Validitycountry_code in ISO list100%Constraint checkOn writeReject write
[DQ-nn][Dimension][Rule][Target][Method][Frequency][Action]

Completeness for a field is measured as:

Completeness=records with a valid non-empty valuetotal records in scope×100%\text{Completeness} = \frac{\text{records with a valid non-empty value}}{\text{total records in scope}} \times 100\%

5. Retention and archival

Entity / data setActive retentionArchiveEnd-of-life actionBasis
Example: Order and order line2 years onlineYears 3 to 7 in archive storageDelete after 7 yearsTax record-keeping rules
Example: Customer (inactive)3 years after last activityNoneAnonymisePrivacy policy
Example: Application logs with IP address90 daysNoneDeleteSecurity policy
[Data set][Period][Archive][Action][Source]

Deletion must cover backups within [35] days of the end-of-life date.

6. Privacy classification and lawful basis

Data categoryFieldsPurposeLawful basisSpecial categoryAccess roles
Example: Contact dataemail, phoneOrder communicationPerformance of contractNoSupport, Operations
Example: Date of birthdate_of_birthAge-restricted productsLegal obligationNoCompliance only
Example: Marketing preferencesopt_in flagsNewslettersConsentNoMarketing
[Category][Fields][Purpose][Basis][Yes / No][Roles]

Data subject rights to support: access, rectification, erasure, restriction, portability and objection, each fulfilled within [30] days.

7. Data lineage and sources

EntitySystem of recordUpstream sourceDownstream consumersRefresh
Example: CustomerCRMWeb sign-up, store sign-upOrder system, data warehouse, email platformReal time
Example: ProductPIMSupplier feedsWeb shop, order systemHourly
Example: OrderOrder systemWeb shop, call centreERP, data warehouseReal time
[Entity][System][Source][Consumers][Frequency]

8. Data interfaces

IDInterfaceDirectionEntitiesFormatFrequency / volumeError handling
DI-01Example: Orders to ERPOutOrder, order lineJSON eventsReal time, 15,000 / dayRetry 5 times; dead-letter queue
DI-02Example: Product feed from PIMInProductCSV over SFTPHourly, 40,000 rowsReject file if over 1% invalid rows
[DI-nn][Interface][In / Out][Entities][Format][Frequency][Handling]

9. Data migration requirements

IDRequirementAcceptance
MIG-01Example: Migrate all customers active in the last 3 years from the legacy CRM.Record counts reconcile within 0.1% with documented exclusions
MIG-02Example: Map legacy status codes to the new status list using mapping table MAP-03.100% of codes mapped; no defaults used
MIG-03Example: Remove duplicates before load using the matching rules in DQ-06.Duplicate rate under 0.5% after load
MIG-04Example: Run two full trial migrations before cut-over.Both trials pass reconciliation
MIG-05Example: Keep the legacy system read-only for 90 days after cut-over.Read access confirmed
[MIG-nn][Requirement][Acceptance]

10. Open issues and revision history

IDIssueOwnerDueStatus
OI-01Example: Confirm retention period for call recordings linked to orders[@privacy-officer]YYYY-MM-DDOpen
[OI-nn][Issue][@name]YYYY-MM-DD[Status]
VersionDateAuthorChange summary
0.1YYYY-MM-DD[@name]Initial draft
[x.y]YYYY-MM-DD[@name][Change]

Standard and licence note

Based on common industry practice for data requirements specification in data management and business analysis. Original text written for this collection; examples are illustrative, and privacy content is a format, not legal advice. Template licence: MIT.

Template liên quan