changelog-writing について
changelog-writingは、機能ブランチの完了後に変更履歴を作成するスキルです。変更内容と文書の情報を集め、ユーザー向けの投稿や画像・リンクの提案をまとめます。
主な機能
- 01ブランチの変更と背景を確認
- 02最近の変更履歴の例を参照
- 03関連文書を検索
- 04ユーザー向けリリースノートを作成
- 05画像や文書リンクを提案
活用シーン
- 01完了した機能の変更履歴を作成
- 02リリースに添える文書リンクを特定
- 03スクリーンショットの要否を判断
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ langfuse/ langfuse --skill changelog-writingインストール後、Claude Code で/changelog-writingを入力して読み込まれたか確認します。
詳細
変更履歴の作成
機能ブランチでの作業が完了し、変更履歴の項目を追加する必要がある場合に、このスキルを使用します。
ワークフロー
- 変更内容を把握します。
../langfuse-docs/pages/changelogにある最近の変更履歴のパターンを確認します。../langfuse-docs/pagesから関連するドキュメントへのリンクを探します。- ユーザー向けの変更履歴の項目を作成します。
- 画像やスクリーンショットを追加すべきかを提案します。
収集する情報
mainとの差分- ブランチ名に
lfe-XXXX識別子が含まれている場合は、Linear の課題 - 影響を受ける製品領域
- リンクする、または作成する関連ドキュメントのページ
執筆ルール
- 内部実装の詳細ではなく、ユーザー向けに書きます
- 手順 2 でコンテキストの把握に Linear の課題を確認する場合でも、項目内では内部のチケット ID や Linear の URL に言及しません
- 「これで〜できるようになりました」のように、ユーザーを主語にする表現を優先します
- 何が変わったのか、なぜ重要なのか、どのように使うのかに焦点を当てます
- 最近の変更履歴の記事の構成とトーンに合わせます
- ユーザーの理解に役立つ場合に限り、技術的な詳細を含めます
出力形式
以下を提示します。
- 変更内容の短い要約
- 変更履歴の記事全文
- 画像を追加すべきかどうか、および画像に表示する内容
- リンクまたは作成すべきドキュメントのページ
参照ファイル
- 変更履歴の保存先:
../langfuse-docs/pages/changelog - 最近の変更履歴の例:このディレクトリにある最近のファイルを 3~5 件確認します
- 既存のドキュメント:
../langfuse-docs/pages
コメント
Markdown 対応