changelog-writing

Name: changelog-writing
Availability: InStock
Author: burburton

Generate structured changelog entries from completion-report and implementation-summary artifacts.

Updated Mar 22, 2026

Search Tags:#changelog #versioning #documentation #compliance #breaking-changes #artifact-contracts

Ready to run

npx skills add https://github.com/Burburton/amazing-specialists --skill changelog-writing-burburton

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: changelog-writing
Source: https://github.com/Burburton/amazing-specialists/tree/main/.opencode/skills/docs/changelog-writing
Command: npx skills add https://github.com/Burburton/amazing-specialists --skill changelog-writing-burburton

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

变更记录往往缺失、不一致或难以追溯，导致用户与开发者难以理解新版本的影响。

Core Features & Use Cases

生成 changelog-entry 工件：为每次发行创建结构化的变更日志条目。
变更类型分类：按 feature/repair/docs-only/governance 对变更进行清晰分类。
破坏性变更与迁移指南：在需要时提供迁移路径和影响说明。
与 readme-sync 协同工作：与文档同步流程无缝衔接，确保信息一致。

Quick Start

使用最新的 completion-report 和 implementation-summary 产出，创建一个新的 changelog-entry。

Frequently Asked Questions about changelog-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate a structured changelog entry for a new release version?▼

To generate a structured changelog entry, this Skill consumes your latest completion-report and implementation-summary artifacts to produce a standardized changelog-entry artifact with explicit change_type classification and known_limitations disclosure.

How do I document breaking changes and provide migration paths in release notes?▼

Documenting breaking changes requires explicit breaking_changes disclosure within your changelog. This Skill enforces breaking_changes disclosure and provides migration paths by applying standardized change_type classification to your release artifacts.

How do I make my versioning documentation compliant with the Keep a Changelog standard?▼

Making versioning documentation compliant involves maintaining a Keep a Changelog compliant structure. This Skill automates structured changelog documentation by enforcing explicit change_type classification and known_limitations disclosure for every release.

What is the best way to classify release changes into features, repairs, and documentation updates?▼

The best way to classify release changes is by applying explicit change_type categories. This Skill automates classification into feature, repair, docs-only, and governance groups using your completion-report and implementation-summary artifacts.

Does this changelog automation work with readme-sync workflows?▼

Yes, this changelog automation works with readme-sync workflows. It ensures information consistency by producing structured changelog-entry artifacts that seamlessly connect with your documentation synchronization processes.

When should I not use automated changelog generation for artifact contracts?▼

You should not use automated changelog generation when your release lacks complete completion-report or implementation-summary artifacts. The Skill relies on consuming these inputs to enforce accurate breaking_changes disclosure and classification.