Skip to content
changelog-update logo

Changelog-Update Skill

changelog-update

Update CHANGELOG.md [Unreleased] section with business-focused entries via systematic file review

SKILL.md

Full skill instructions

Changelog-Update Skill

Update CHANGELOG.md with business-focused entries by systematically reviewing file changes.

Note: For automated release notes from conventional commits, use the release-notes skill instead.

When to Use

  • During development: Document feature/​fix for users before PR/​merge
  • PR preparation: Add business-focused entry to CHANGELOG.md
  • Manual documentation: When commits don't capture full business impact

Don't use for releases: Use release-notes skill to generate versioned release docs.

Pre-Execution Checklist

  1. Find existing CHANGELOG.md location

    • Check root: ./​CHANGELOG.md (preferred)
    • Fallback: ./​docs/​CHANGELOG.md
    • If not found: Create at root
  2. Read current changelog to understand format and last entries

Workflow

Step 1: Gather Changes

Determine change scope:

  • PR-based: git diff origin/​develop...HEAD --name-only
  • Branch-based: git log origin/​develop..HEAD --oneline
  • Commit-based: git show {commit} --name-only

Step 2: Create Temp Notes File

Create .ai/​workspace/​changelog-notes-{YYMMDD-HHMM}.md:

# Changelog Review Notes - {date}

## Files Changed
- [ ] file1.ts -
- [ ] file2.cs -

## Categories
### Added (new features)
-

### Changed (modifications to existing)
-

### Fixed (bug fixes)
-

### Deprecated
-

### Removed
-

### Security
-

## Business Summary
<!-- What does this mean for users? -->

Step 3: Systematic File Review

For each changed file:

  1. Read file or diff
  2. Identify business impact (not just technical change)
  3. Check box and note in temp file
  4. Categorize into appropriate section

Business Focus Guidelines:

  • ❌ "Added StageCategory enum"
  • ✅ "Added stage categories (Sourced, Applied, Interviewing, etc.) for pipeline tracking"
  • ❌ "Created PipelineController.cs"
  • ✅ "Added API endpoints for pipeline management"

Step 4: Holistic Review

Read temp notes file completely. Ask:

  • What's the main feature/​fix?
  • Who benefits and how?
  • What can users now do that they couldn't before?

Step 5: Generate Changelog Entry

Format (Keep a Changelog):

## [Unreleased]

### {Feature/​Module Name}: {Feature Title}

**Feature/​Fix**: {One-line business description}

#### Added
- {Business-focused item}

#### Changed
- {What behavior changed}

#### Fixed
- {What issue was resolved}

Step 6: Update Changelog

  1. Read existing CHANGELOG.md
  2. Insert new entry under [Unreleased] section
  3. If no [Unreleased] section, create it after the header

Step 7: Cleanup

Delete temp notes file: .ai/​workspace/​changelog-notes-*.md

Examples

Good Entry

### bravoTALENTS: Hiring Process Management

**Feature**: Customizable hiring process/​pipeline management for recruitment workflows.

#### Added
- Drag-and-drop pipeline stage builder with default templates
- Stage categories (Sourced, Applied, Interviewing, Offered, Hired, Rejected)
- Pipeline duplication for quick setup
- Multi-language stage names (EN/​VI)

Bad Entry (Too Technical)

### Pipeline Changes

#### Added
- Pipeline.cs entity
- StageCategory enum
- PipelineController
- SavePipelineCommand

Anti-Patterns

  1. ❌ Creating new changelog in docs/ when root exists
  2. ❌ Skipping file review (leads to missed changes)
  3. ❌ Technical jargon without business context
  4. ❌ Forgetting to delete temp notes file
  5. ❌ Not using [Unreleased] section

More Productivity & Planning skills

brainstorming logo
Productivity & Planning

brainstorming

Structured design dialogue that validates ideas before implementation begins.

295.4K 385.7K
View
ui-ux-pro-max logo
Productivity & Planning

ui-ux-pro-max

Comprehensive design intelligence for web and mobile UI/UX across 10 technology stacks.

133.1K 383.9K
View
writing-plans logo
Productivity & Planning

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K
View
using-superpowers logo
Productivity & Planning

using-superpowers

Introduction to the obra skills system with mandatory skill invocation rules and best practices.

295.4K 259.8K
View
executing-plans logo
Productivity & Planning

executing-plans

Execute a written implementation plan with critical review and task checkpoints.

295.4K 229.1K
View
dispatching-parallel-agents logo
Productivity & Planning

dispatching-parallel-agents

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K
View
using-git-worktrees logo
Productivity & Planning

using-git-worktrees

Isolated git worktrees with smart directory selection and safety verification.

295.4K 205.2K
View
webapp-testing logo
Productivity & Planning

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

179.7K 170.6K
View
content-strategy logo
Productivity & Planning

content-strategy

Plan searchable and shareable content that drives traffic, builds authority, and generates leads.

53.3K 150.9K
View
repo-intake-and-plan logo
Productivity & Planning

repo-intake-and-plan

README-first repository scanner that extracts commands and classifies reproduction candidates without executing them.

497 139.6K
View
marketing-ideas logo
Productivity & Planning

marketing-ideas

Brainstorm and prioritize marketing strategies tailored to your SaaS stage, budget, and goals.

53.3K 137.2K
View
site-architecture logo
Productivity & Planning

site-architecture

Plan and optimize your website's page hierarchy, navigation, URL structure, and internal linking.

53.3K 112.8K
View

Productivity AI tools

Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View
SaveDay logo
Productivity

SaveDay

Capture, organize, and utilize your knowledge effortlessly.

Free
View
Any Summary logo
Productivity

Any Summary

Instant Summaries of Audio & Video Interviews with AnySummary

Freemium
View
M
Productivity

Map This

Transform PDFs into engaging mind maps.

Freemium
View
ChatPDF logo
Productivity

ChatPDF

Chat with any PDF instantly

Free
View
I
Productivity

intellisay

Create an optimal daily plan using your voice

Paid
View
A
Productivity

Aurora AI

A productivity platform to centralize organizational knowledge and workflows with contextual AI assistance.

Paid
View
AskYourPDF logo
Productivity

AskYourPDF

AskYourPDF Pricing Plans: Tailored to Your Needs

Free
View