Model Governance for Content Types
Governance standards keep your content models consistent, scalable, and safe to evolve across your stack. This guide shows you how to introduce content model changes without breaking the websites, applications, or integrations that depend on your structured content.
Who Is This For?
This guide is for:
- Solution architects
- Developers who manage content models
- Teams responsible for maintaining structured content at scale
Before You Begin
- Understand how to create and manage content types.
- Identify the systems that consume your content, such as websites, apps, and APIs.
Naming Standards
Use consistent, predictable naming for content type and field UIDs.
Recommended guidelines:
- Use lowercase snake_case (for example, blog_post or hero_title).
- Keep names semantic and stable so they reflect purpose, not UI labels.
- Avoid generic names such as data, info, or content.
- Use consistent suffixes where helpful: _title, _description, _image, _url, _slug, and _cta_label.
Why this matters: Consistent naming keeps integrations stable and easier to maintain over time.
Example conventions:
| Object | Recommended UID | Avoid |
|---|---|---|
| Content type | blog_post | BlogPostV2Final |
| Slug field | slug | page_url_slug_value |
| Hero title field | hero_title | title1 |
Versioning Strategy
When you update a content model, choose the least disruptive approach.
Additive changes (preferred)
- Add new optional fields without modifying existing ones.
- Existing integrations are unaffected.
Parallel versioning
- Create a new content type (for example, blog_post_v2).
- Use this approach when the structure changes significantly.
Migration and cutover
- Migrate entries to the new structure.
- Update the consuming systems.
- Deprecate the old fields or content types.
Best practice: Treat content model changes like API changes, and always evaluate downstream impact.
Deprecation Policy
Avoid removing or repurposing fields immediately. Instead, follow a staged lifecycle.
Recommended lifecycle:
- Mark the field as deprecated (for example, [Deprecated] hero_subtitle).
- Stop using it in new content.
- Migrate existing entries to replacement fields.
- Update all consuming systems.
- Remove the field only after validation.
Change Management
Before you make changes
- Identify all consuming systems, such as web, mobile, APIs, and automations.
- Define required versus optional field behavior.
- Review locale and environment impact.
- Plan for backward compatibility.
- Define a rollback strategy.
After you make changes
- Validate entries using the Delivery API.
- Confirm field mappings in the consuming systems.
- Monitor for errors, such as missing or renamed fields.
Branch Governance
Content types are branch-specific, so manage schema changes carefully.
- Apply changes in a non-production branch first.
- Test entries, APIs, and rendering.
- Promote to production only after validation.
Why this matters: Unvalidated changes in production can break content delivery and integrations.
Ownership and Documentation
For each content type, maintain documentation that includes:
- Purpose and owner
- Required fields
- Reference dependencies
- Deprecated fields and their replacements
- Last reviewed date
Consistent documentation supports long-term maintainability and reduces risk during updates.