← All guides

From a change log to the reader’s next action

What changed—and what should I do?

Release notes explain verified changes in a specific version, who can use them and what action affected readers need to take.

Make this with my agent

Bring your notes. Review a draft before sharing.

Explore the method
  1. 01
    Show the exact change

    New CSV downloads use customer_id instead of account_id as the first header.

  2. 02
    Name who needs to act

    Integration owners review mappings; the importer does not rename fields automatically.

  3. 03
    Bound availability

    Hosted-workspace availability is confirmed. On-premise availability and a migration deadline are not.

THE REAL HTML · FICTIONAL EXAMPLEView on its own

A worked example, not a customer result. September 2026 dates are sample facts.

Now make it about your work

Your release. Your agent. Their next step.

Make availability, compatibility limits and required action easier to find than the implementation history.

Start with three things

  1. The exact version, verified shipped changes and rollout scope.
  2. Affected workflows and approved compatibility instructions.
  3. Known limitations, audience-safe references and required actions.
Make this with my agent

You review the facts and access. Nothing is published without your approval.

The method behind the release notesAsk your agent to translate verified changes into reader impact, preserving exact technical names and keeping unshipped work out of the claims.

How can my agent turn a change log into useful release notes?

Supply the verified release scope, availability, compatibility notes, and approved instructions. Ask your agent to group changes by their effect on the reader: what is new, what changes, and what action is required. Keep planned work and unverified fixes out of the release claims, then review the static page before sharing.

What to give your agent

  • The exact release version, date, and verified included changes—not every merged ticket.
  • Confirmed rollout scope, supported environments, and any staged or preview availability.
  • Approved compatibility and migration instructions, including known limitations.
  • Audience-safe evidence, support links, and any action readers must take.
  1. Verify what is actually available

    A merged change may not be deployed, enabled, or available to every user. State the exact version and audience. Keep previews, staged rollouts, and future work visibly separate from generally available functionality.

  2. Translate changes into reader impact

    Ask who notices each change and what becomes different in their existing workflow. Group related implementation details under that effect. Preserve limitations even when they complicate the headline; avoid claiming a fix resolves every similar symptom.

  3. Put required action before celebration

    If a format or behavior changes, say which users need to act, under what condition, and where the approved instructions live. Do not invent migration commands, automatic upgrades, compatibility guarantees, or deadlines. An absent instruction is a question to resolve before release communication.

  4. Check the page against the shipped scope

    Review each claim with the release owner. Remove private issue discussions and unsuitable internal links. Share a dated HTML reading page only after approval, while keeping the authoritative release history and technical documentation in their established locations.

Keep creating and revising in the agent you already use. Start with a saved artifact style and learn how to update HTML without changing its link.

Use the full promptReady for your agent and your notes

Use the conversation where you already did the work. Only attach material you are allowed to share.

Get the ready-to-copy creation request →
Using only authorized release notes, verified shipped scope, and approved instructions, draft release notes for [version] and [audience]. Ask for missing version, date, rollout scope, compatibility details, and required actions. Separate shipped changes from merged or planned work. Lead with reader impact and required action, then improvements and known limitations. Preserve exact field names and affected environments. Do not invent fixes, performance gains, migration commands, deadlines, automatic upgrades, or compatibility guarantees. Leave missing availability explicitly unconfirmed. Link only to supplied audience-safe documentation; exclude private issue notes. Create static HTML with no scripts, forms, or live-data claims. Apply my saved artifact style if available. Return a draft and verification questions. Do not publish or change access without separate explicit approval; publishing these notes must not trigger a release or deployment.
Check before you shareAccuracy, clarity, and permission
  • Does every availability claim match the released version and rollout scope?
  • Can an affected reader find the required action before the feature list?
  • Are technical names, compatibility conditions, and known limitations exact?
  • Are planned work and missing instructions kept out of confirmed release claims?
  • Are linked sources safe for this audience?

When HTML fits

A reader-facing announcement or release companion that explains verified technical changes without requiring everyone to read a pull-request list.

When another format fits better

Keep version history, package downloads, support procedures, and migration execution in their existing systems. If the native release page already serves users well, improve it instead of creating another copy. This page does not ship software or make changes to a reader's system.

What we started withThe same facts, as a wiki page

Fictional team wiki

Kite Reports 2.4 — CSV header change, review draft

Availability

Devon verified availability on September 7, 2026, for hosted-workspace users only. On-premise availability is unconfirmed.

What changed

Change R-24: newly downloaded CSV files use customer_id instead of account_id for the first column header. Identifier values and the other columns are unchanged. Existing downloaded files are not rewritten.

Who is affected

Integration owners whose mappings use the old header need to review them before adopting new exports. People who only view hosted reports do not need to change mappings for viewing. Compatibility C-24: the importer requires explicit mapping; it does not rename fields automatically or modify external integrations. There is no universal backwards-compatibility assurance.

Adoption and verification

Ask Devon for approved instructions if needed. No procedure, command, documentation URL or migration deadline is supplied. Only the header change is verified here. A merged download-performance ticket is not verified as released, and there are no quantitative performance results.

Review and sharing limits

These fictional field names are not instructions for an actual product. Source issue URLs and support contacts are absent. This draft needs human approval and an audience/access choice before publication. Sharing it does not deploy software, edit mappings or authorize environment changes; it is not the authoritative distribution channel.

Inspect the HTMLOne self-contained file

The example is sanitized and isolated from this site. No scripts, forms, or live data.

<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>Kite Reports 2.4 · Release notes</title><style>
*{box-sizing:border-box}html{color-scheme:light}body{margin:0;background:#f6f8f5;color:#20352f;font:17px/1.65 system-ui,sans-serif}main{max-width:1000px;margin:auto;padding:clamp(20px,5vw,64px)}h1,h2,h3,p{margin:0 0 18px}h1{font:500 clamp(32px,5vw,58px)/1.14 Georgia,serif;letter-spacing:-.025em;overflow-wrap:anywhere}h2{font:500 29px/1.3 Georgia,serif;overflow-wrap:anywhere}h3{font-size:19px;line-height:1.4}.label{font:700 12px/1.6 system-ui,sans-serif;letter-spacing:.08em;text-transform:uppercase}.intro{font-size:20px}.lead{background:#174b40;color:white;padding:24px;margin:28px 0}.lead p:last-child{margin:0}.grid{display:grid;grid-template-columns:repeat(auto-fit,minmax(min(100%,230px),1fr));gap:20px;margin:24px 0}.card{background:white;border:1px solid #bbc5c4;padding:24px}.metric{font:500 38px/1.2 Georgia,serif;display:block;margin-bottom:12px}section{margin:36px 0}ul,ol{padding-left:22px}li{margin-bottom:12px}.note{font-size:14px}.warning{border-left:5px solid #956118;padding-left:20px}a{color:inherit;text-underline-offset:4px}a:focus-visible,summary:focus-visible{outline:3px solid #956118;outline-offset:4px}table{width:100%;border-collapse:collapse;table-layout:fixed;font-size:15px}th,td{text-align:left;vertical-align:top;border-bottom:1px solid #bbc5c4;padding:12px 8px;overflow-wrap:anywhere}caption{text-align:left;font-weight:700;padding:12px 0}pre,code{white-space:pre-wrap;overflow-wrap:anywhere}footer{border-top:1px solid #bbc5c4;padding-top:24px;margin-top:40px;font-size:14px}@media(max-width:480px){th,td{padding:10px 4px;font-size:14px}}@media print{body{background:white}.card,.lead{break-inside:avoid}h2,h3{break-after:avoid}}
</style></head><body><main><header><p class="label">Fictional product / Version 2.4 / September 7, 2026</p><h1>A new CSV header. Review your mapping before adopting it.</h1><p class="intro">Available to hosted-workspace users. On-premise availability is not confirmed.</p></header>
<section class="lead"><p class="label">Action for integration owners</p><h2>Check mappings that use the old first-header name.</h2><p>If your integration consumes newly downloaded CSV files, review its mapping before adopting new exports. The importer does not rename fields automatically.</p></section>
<section><h2>The exact change</h2><div class="grid"><article class="card"><p class="label">Previous first header</p><h3><code>account_id</code></h3></article><article class="card"><p class="label">New download first header</p><h3><code>customer_id</code></h3></article></div><p>Identifier values and the other columns are unchanged. Source: verified change R-24.</p></section>
<section><h2>What does not change</h2><ul><li>Existing downloaded files are unchanged; the release does not rewrite them.</li><li>External integrations are not modified automatically.</li><li>Readers only viewing the hosted report do not need to change CSV mappings for viewing.</li></ul></section>
<section class="warning"><h2>Instructions still need a source</h2><p>No detailed migration procedure, documentation URL, or migration deadline was supplied. Ask the release owner for approved instructions if needed. This page does not invent commands or promise compatibility.</p><p class="note">Source: compatibility note C-24. Release owner: Devon.</p></section>
<section><h2>Not part of this announcement</h2><p>A merged performance ticket was not verified as released. These notes make no download-speed improvement claim.</p><p>Publishing release notes does not deploy software or authorize changes to an integration. Use the established release and update workflows.</p></section><footer>Fictional worked example by share/artifacts. Names, dates, figures and records are invented for demonstration. Static snapshot; no live data or automatic updates.</footer></main></body></html>
The original worked scenarioThe source scenario, step by step

A small export change with a specific reader action

A fictional reporting tool releases version 2.4. The example is not a real product migration instruction.

The original notes

Version 2.4 is available September 7 to hosted-workspace users. New CSV downloads use customer_id instead of account_id as the first header. Existing downloaded files are unchanged. The importer still requires explicit mapping; it does not rename fields automatically. Integration owners should review their mapping before adopting new exports. On-premise availability is not confirmed. No migration deadline or performance improvement was supplied.

Available to

Version 2.4 is available September 7 to hosted-workspace users.

What changes

New CSV downloads use customer_id instead of account_id as the first header.

What stays

Existing downloaded files are unchanged.

Your action

Integration owners should review their mapping before adopting new exports; the importer does not rename fields automatically.

Not established

On-premise availability, a migration deadline, and a performance improvement are not confirmed.

The important change is not the code edit. It is the action a reader needs before their next export.

Questions, adaptations & sourcesGo deeper when you need to

Can my agent start with generated GitHub release notes?

Yes, if you authorize access. Generated notes can supply a change inventory, but the release owner still needs to verify availability, user impact, and compatibility. A merged pull request alone does not establish those facts.

Should every bug fix appear?

Include fixes that matter to the audience and summarize the verified effect. Keep a full changelog link when supplied. Do not hide a material limitation merely to make the list shorter.

Can the page perform the migration?

No. It is a static explanation. Use approved documentation and the established update workflow for any actual changes; the agent must not infer deployment permission from permission to draft release notes.

Further reading