Our review
Generates or updates changelog entries by systematically reviewing file changes using git diff and categorizing them into a Keep a Changelog format.
Strengths
- Business-focused language instead of technical jargon
- Systematic workflow with temp notes and checklists
- Supports various git diff modes (PR, commit, range)
- Preserves existing changelog structure
Limitations
- Requires a git repository with commit history
- Manual review of each file may be time-consuming for large diffs
- Assumes changelog file location in root or docs folder
When you need to create a clear, business-oriented changelog for a release or update.
When the changelog is automatically generated by a CI tool or when you need fine-grained control over every entry.
Security analysis
SafeThe skill only reads file diffs using git commands and writes to local changelog files; no destructive or network operations are instructed, and no secrets are exfiltrated.
No concerns found
Examples
Generate a changelog for the current branch compared to develop.Update the changelog with changes between commit abc123 and def456.Add a changelog entry for the most recent commit.name: changelog version: 1.1.0 description: '[Documentation] Generate or update changelog entries. Use for release changelogs, version history, and change tracking across any project.' triggers: - changelog - update changelog - add changelog - log changes
allowed-tools: NONE
[IMPORTANT] Use
TaskCreateto break ALL work into small tasks BEFORE starting — including tasks for each file read. This prevents context loss from long files. For simple tasks, AI MUST ask user whether to skip.
Quick Summary
Goal: Generate business-focused changelog entries by systematically reviewing file changes.
Workflow:
- Gather Changes — Get changed files via
git diff(PR, commit, or range mode) - Create Temp Notes — Build categorized review notes (Added/Changed/Fixed/etc.)
- Review Each File — Read diffs, identify business impact, categorize changes
- Generate Entry — Write Keep-a-Changelog formatted entry under
[Unreleased] - Cleanup — Delete temp notes file
Key Rules:
- Use business-focused language, not technical jargon (e.g., "Added pipeline management" not "Added PipelineController.cs")
- Group related changes by module/feature, not by file
- Always insert under the
[Unreleased]section; create it if missing
Changelog Skill
Generate business-focused changelog entries by systematically reviewing file changes.
Pre-Execution Checklist
-
Find existing CHANGELOG.md location
- Check root:
./CHANGELOG.md(preferred) - Fallback:
./docs/CHANGELOG.md - If not found: Create at root
- Check root:
-
Read current changelog to understand format and last entries
Workflow
Step 1: Gather Changes
Determine change scope based on mode:
# PR/Branch-based (default)
git diff origin/develop...HEAD --name-only
# Commit-based
git show {commit} --name-only
# Range-based
git diff {from}..{to} --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:
- Read file or diff
- Identify business impact (not just technical change)
- Check box and note in temp file
- Categorize into appropriate section
Business Focus Guidelines:
| Technical (Avoid) | Business-Focused (Use) |
| ------------------------------- | -------------------------------------------- |
| Added StageCategory enum | Added stage categories for pipeline tracking |
| Created PipelineController.cs | Added API endpoints for pipeline management |
| Fixed null reference in GetById | Fixed pipeline loading error |
| Added migration file | Database schema updated for new features |
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]
### {Module}: {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
- Read existing CHANGELOG.md
- Insert new entry under
[Unreleased]section - If no
[Unreleased]section, create it after header - Preserve existing entries
Step 7: Cleanup
Delete temp notes file: .ai/workspace/changelog-notes-*.md
Grouping Strategy
Group related changes by module/feature:
### Your Service: Hiring Process Management
**Feature**: Customizable hiring process/pipeline management.
#### Added
**Backend**:
- Entities: Pipeline, Stage, PipelineStage
- Controllers: PipelineController, StageController
- Commands: SavePipelineCommand, DeletePipelineCommand
**Frontend**:
- Pages: hiring-process-page
- Components: pipeline-filter, pipeline-stage-display
Anti-Patterns
- ❌ Creating new changelog in docs/ when root exists
- ❌ Skipping file review (leads to missed changes)
- ❌ Technical jargon without business context
- ❌ Forgetting to delete temp notes file
- ❌ Not using [Unreleased] section
- ❌ Listing every file instead of grouping by feature
Examples
Good Entry
### Your Service: 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)
#### Changed
- Candidate cards now show current pipeline stage
- Job creation wizard includes pipeline selection
Bad Entry (Too Technical)
### Pipeline Changes
#### Added
- Pipeline.cs entity
- StageCategory enum
- PipelineController
- SavePipelineCommand
- 20251216000000_MigrateDefaultStages migration
Reference
See references/keep-a-changelog-format.md for format specification.
Related
documentationrelease-notescommit
IMPORTANT Task Planning Notes (MUST FOLLOW)
- Always plan and break work into many small todo tasks
- Always add a final review todo task to verify work quality and identify fixes/enhancements
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.