Skip to main content

Your release agent named an internal cluster in a customer note.

Check each note against your change policy before it reaches customers.

What your agent writes
Release notes and change records.
Who owns the standard
Release Manager and IT Compliance

Rules that usually apply

These are examples to adapt. Write your own rules in plain language, or use public rules, and every agent reads the same rule.

  • Internal names stay internal

    No internal system, cluster, or team name appears.

  • Impact is specific

    Customer impact is a number or a time range, never "some" or "a few."

  • Plain past tense

    Changes are described in plain past tense.

  • Rollback plan

    A rollback plan is stated, not referenced.

What a critique looks like

Sample critique. Illustrative data written by Vindex. Not a customer result.

An agent drafts customer-facing release notes from an engineering change log.

One call checks the rule set “Release note standards”: Internal names stay internal, Impact is specific, Plain past tense.

Attempt 1

Agent output

Release 4.12: We migrated the billing service off Kafka cluster ORION onto the new event bus. Some invoices may show a delay. All invoices are now processed on time.

Result for each rule

  • Internal names stay internal v1Fail
    • “Kafka cluster ORION”
  • Impact is specific v2Fail
    • “Some invoices may show a delay”
  • Plain past tense v1Pass

Rule set: Fail (failed: Internal names stay internal, Impact is specific)

val_sample_0005 · attempt 1 · 86 credits left

Attempt 2

Agent output

Release 4.12: Invoices created between 09:00 and 11:30 UTC on October 8 appeared up to 2 hours late. We moved invoice processing to a new event system. All invoices are now processed on time.

Result for each rule

  • Internal names stay internal v1Pass
  • Impact is specific v2Pass
  • Plain past tense v1Pass

Rule set: Pass

val_sample_0006 · attempt 2 · 85 credits left