SKILL.md
唯讀
名稱
changelog-generator
描述
自動從 Git 提交記錄產生面向使用者的更新日誌,透過分析提交歷史、分類變更,並將技術性提交轉換為清晰、客戶友善的版本說明。將數小時的手動更新日誌撰寫縮短為數分鐘的自動生成。
更新日誌產生器
這個技能能將技術性的 Git 提交記錄轉換為精緻、使用者友善的更新日誌,讓你的客戶和使用者真正看得懂且喜歡。
何時使用此技能
- 準備新版本的版本說明
- 建立每週或每月的產品更新摘要
- 為客戶記錄變更
- 撰寫應用程式商店送審的更新日誌
- 產生更新通知
- 建立內部版本文件
- 維護公開的更新日誌/產品更新頁面
此技能的功能
- 掃描 Git 歷史:分析特定時間範圍或版本之間的提交記錄
- 分類變更:將提交記錄分組為邏輯類別(功能、改善、錯誤修正、重大變更、安全性)
- 技術轉換為使用者語言:將開發者的提交轉換為客戶用語
- 專業格式:建立乾淨、結構化的更新日誌條目
- 過濾雜訊:排除內部提交(重構、測試等)
- 遵循最佳實務:套用更新日誌指南和你的品牌語調
如何使用
基本用法
在你的專案儲存庫中:
從上次發佈後的提交記錄建立更新日誌
產生過去一週所有提交的更新日誌
為 2.5.0 版本建立版本說明
指定日期範圍
建立 3 月 1 日至 3 月 15 日期間所有提交的更新日誌
自訂指南
從 v2.4.0 之後的提交建立更新日誌,使用 CHANGELOG_STYLE.md 中的更新日誌指南
範例
使用者:「為過去 7 天的提交建立更新日誌」
輸出:
# 更新 - 2024 年 3 月 10 日當週
## ✨ 新功能
- **團隊工作區**:為不同專案建立獨立工作區。邀請團隊成員,保持一切井然有序。
- **鍵盤快捷鍵**:按下 ? 查看所有可用快捷鍵。無需滑鼠即可更快操作。
## 🔧 改善
- **更快的同步**:檔案現在跨裝置同步速度提升 2 倍
- **更好的搜尋**:搜尋現在包含檔案內容,而不只是標題
## 🐛 錯誤修正
- 修正大圖片無法上傳的問題
- 解決排程文章中的時區混淆
- 修正通知徽章計數
靈感來源: Manik Aggarwal 在 Lenny's Newsletter 中的使用案例
提示
- 在 Git 儲存庫根目錄執行
- 指定日期範圍以聚焦特定更新日誌
- 使用你的 CHANGELOG_STYLE.md 確保格式一致
- 發佈前檢查並調整產生的更新日誌
- 直接將輸出儲存到 CHANGELOG.md
相關使用案例
- 建立 GitHub 版本說明
- 撰寫應用程式商店更新描述
- 為使用者產生電子郵件更新
- 建立社群媒體公告貼文




