Engineering — Advanced

Changelog Generator

Changelog Generator: Create a usable technical explanation. Review the source code or artifact, audience, sequence, and format and produce a technical document or visual walkthrough.

Download SKILL.md

---
name: engineering-changelog-generator
description: Use for changelog generator when asked to create a usable technical explanation; produce a technical document or visual walkthrough.
license: MIT
metadata:
author: Thrive
category: engineering
---

# Changelog Generator

## When to use

Use this skill for changelog generator when you need to create a usable technical explanation. The expected result is a technical document or visual walkthrough.

## Boundaries

Work within the requested task and its stated acceptance criteria. Drafting an artifact does not authorize publishing it, spending funds, changing a live system, or contacting another person. Identify any such action separately before taking it.

## Inputs

Inspect the source code or artifact, audience, sequence, and format. Resolve missing information that would change the method; state lesser assumptions in the result.

## Method

1. **Diagnose.** Identify the runtime boundary, data shape, dependencies, deployment path, and the constraint that dominates the design.
2. **Decide.** Show the important steps and link claims to the underlying artifact.
3. **Produce.** Build a technical document or visual walkthrough from the inspected material; keep assumptions distinguishable from observed facts.

## Decision rules

- Compare implementation choices on correctness, compatibility, performance, operability, and reversibility. Choose against the actual workload.
- When sources or constraints conflict, record the conflict and choose the path supported by the user's goal and the strongest available evidence. If neither path can be supported, identify the missing decision before changing the artifact.

## Domain rules

- Check compatibility, performance, security, and operational cost for the chosen implementation.
- Include migration and rollback steps when contracts or persisted data change.

## Verification

Check that the explanation remains accurate after a cold read. Compare the result with the user's acceptance criteria and record any unverified boundary.

Supply the artifact, migration notes when needed, measured or tested behavior, and a rollback condition for risky changes.

## Stop conditions

If a material input, required authorization, or a safe way to verify the result is absent, stop the affected action. Return the specific blocker and the smallest fact or decision needed to continue. Do not report an unrun check as passed.

## Output

Provide a technical document or visual walkthrough. Include the decisive evidence and actual verification result. Name any artifact location and unresolved issue that affects its use.

<!--
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-->