Update changelog.txt for customer releases. Use when preparing release notes, adding new entries, removing sections, or reformatting existing entries. Helps maintain consistent detail level and customer-appropriate language.
This skill helps prepare customer-facing changelog entries with consistent formatting and appropriate detail level.
Release XXX - MM/DD/YY
TFU-XXX Feature Name
Brief customer-facing description of what changed and why it matters.
- Specific change 1
- Specific change 2
Feature/Fix Name (no ticket)
Description
Customer-Appropriate (GOOD):
Too Technical (AVOID):
Good - Customer-focused:
TFU-318 Icon Symbology Overhaul
Major symbology system refactor:
- Created configuration-driven SymbologyService for centralized symbology handling
- Added Map Settings tab for visual symbology changes (ESC menu -> Settings)
Too Detailed - Developer-focused:
TFU-501 Suspect Coloring Fix
Issue: Suspect coloring of several assets using the affiliation of Suspect tracks are colored incorrectly when symbology is changed
Changes:
Line of Bearing pairing line changed to use Affiliation MS Solid color
Line of Bearing cone changed to use Affiliation MS Solid color
...
The second example might be better condensed to:
TFU-501 Suspect Coloring Fix
Fixed suspect track coloring when symbology is changed
- Line of Bearing pairing lines and cones now use correct affiliation colors
- Updated suspect color scale to use darker orange (#DC6100)
Read changelog.txt
Identify:
Ask user:
# List MRs merged in the last week
glab mr list --state=merged --merged-after=$(date -d '7 days ago' +%Y-%m-%d)
# View specific MR details for description
glab mr view <MR_NUMBER>
# List all merged MRs (paginated)
glab mr list --state=merged
glab mr view)git log --oneline origin/development..HEADBefore making changes:
Is it visible to the end user?
├── Yes → Include, describe user impact
└── No → Is it a schema/model change customers integrate with?
├── Yes → Include, document the change
└── No → Skip or mention briefly
Before:
TFU-501 Suspect Coloring Fix
Issue: Suspect coloring of several assets...
Changes:
Line of Bearing pairing line changed to use Affiliation MS Solid color
Line of Bearing cone changed to use Affiliation MS Solid color
Engagement pairing line changed to use affiliation MS Solid color
Suspect color scale changed to use #DC6100 as the base instead of #FFA762
(A darker and more orange scale)
After:
TFU-501 Suspect Coloring Fix
Fixed suspect track coloring when symbology changes
- LoB and engagement pairing lines now use correct affiliation colors
- Updated suspect color scale to darker orange
Schema/model changes are OK to document with code if customers integrate:
- Added UncertaintyVolume entity for track position uncertainty visualization
Internal implementation details should be removed:
// Don't include:
export class GeoCylinder {
public static class: string = "quicktype.GeoCylinder";
...
}