Release notes and changelog
Dated product changes and migration notes.
Release notes and changelog
VELORYZ Studio · Legal, policies and product updates Audience: Customers, compliance reviewers and Studio administrators Guide type: Practical Studio operations guide
Purpose
Release notes and changelog should be treated as an end-to-end responsibility, not an isolated button. Start by defining what will change, who can approve it and how success will be checked. Dated product changes and migration notes.
Release notes should only list releases verified in source control or the active hosting environment.
Availability and responsibility
These guides explain how to evaluate privacy, copyright, acceptable use and release changes. They are not signed legal agreements, legal advice, certification or a promise of particular entitlements; authoritative terms depend on current approved policies and project contracts.
Before committing time or budget, confirm who operates this workflow: the visitor, the client portal user, a Studio owner, or the delivery team. A feature described in design documentation is not automatically a public account entitlement.
Before you begin
- Approved policy or agreement version and effective date
- The data categories, assets and third-party services actually used
- A named reviewer authorised to approve public legal language
- A short list of measurable success criteria specifically for release notes and changelog.
- A recovery plan if the proposed change creates a regression.
Recommended procedure
- Locate the relevant area or public route. For new projects, establish the brief at /create/; for owner-only content changes, use authenticated Studio Control at /admin. Do not assume a missing feature exists.
- Define the specific work item for Release notes and changelog: capture the initial state, user intent, relevant data, permissions, expected output and what must not change.
- Follow the design and operating decisions listed below. Work in a draft, staging or reviewed project handoff where available; avoid editing live customer data experimentally.
- Review the effect with real content and realistic viewport sizes. Record any exception and obtain the appropriate approval before a public change.
- After the change, verify the public outcome rather than relying on a success message alone; preserve a reference to the reviewed version.
Topic-specific operating procedure
These steps apply to Release notes and changelog. The implementation must be verified against the current Studio permissions, deployed provider connections and approved project scope.
- Maintain release entries with actual date, source commit or publication revision, scope and affected users.
- Separate new features, changes, fixes, deprecations and known limitations.
- Avoid claiming a deployment merely because code was committed to GitHub.
- Link to affected docs and provide upgrade or migration actions where needed.
Evidence to retain
- The original input or situation, and a clear before/after comparison.
- The reviewed version, responsible owner and acceptance record.
- Any limitation, follow-up decision, or safely reversible workaround.
Configuration and decision points
- Identify the relevant approved agreement, privacy notice or licensing document before publication.
- Record responsibilities for original content, third-party assets, personal data and client handover.
- Separate operational guidance from legally binding terms and signed approvals.
- Review policy changes with appropriate legal or privacy expertise as needed.
When more than one implementation is possible, prefer the simplest approach that remains accessible, maintainable and compatible with the current source. Note any cost, licensing, privacy, ownership and performance implications before approval.
Verification checklist
- Ownership promises are consistent with written agreements and vendor licenses.
- Privacy disclosures match actual data flows and retention periods.
- Changelog entries contain verifiable dates, impact and any required action.
- Known issues describe a confirmed state rather than invented uptime or incidents.
Also confirm that the result addresses the original objective: Dated product changes and migration notes.. Review the customer-visible language, error states, navigation paths and the relevant device widths. A green build or a successful save does not by itself establish a correct production outcome.
Troubleshooting and recovery
- If rights cannot be confirmed, pause publication or remove the disputed material.
- If policy language is outdated, replace it only after approved review.
- If a published update is erroneous, issue a clear correction and preserve the change record.
When asking for assistance, include the exact public URL or project reference, a concise reproduction path, the expected behaviour, actual behaviour, relevant timestamps and a redacted screenshot if useful. Never include passwords, access tokens or private customer records.
Related reading
- [Privacy and data handling](/docs/studio/policies/privacy/)
- [Acceptable use and content rules](/docs/studio/policies/acceptable-use/)
- [Known issues](/docs/studio/known-issues/)
- [All VELORYZ documentation](/docs/)
- [Studio documentation](/docs/studio/)
- [Help Centre](/help/studio/)
- [/create/](/create/)
- [/docs/overview/](/docs/overview/)
Operational note
This article describes the Studio workflow and its acceptance criteria. Where a self-service control is not available, the action is coordinated with the Studio team rather than silently represented as automated.
