すべてのユースケース

顧客向けリリースノートの自動生成

Zeroがコミットとマージ済みPRを読み、顧客への影響別に変更をグループ化し、明確で具体的なリリースノートを作成します。

Zeroの接続先:GitHubSlack

Zeroが出力する結果

課題

リリースノートは常に、最後に書かれ、リリースが押した時に真っ先にカットされるものです。原因は素材にあります:エンジニア向けに書かれたコミットメッセージ、暗黙知を前提にしたPRタイトル、個別ではユーザーがほぼ気にしない30件のマージ済みPR。Release Notes Generatorはワークフローを反転させます。ZeroがコミットとPR説明を読み、顧客に見える変更だけを残し、テーマ(新機能、改善、修正)でまとめ、顧客が実際に読むボイスでノートを書きます。あなたがレビューすれば、次のリリースは沈黙ではなくノート付きで出荷されます。

Zeroによる解決方法

ステップ1:ツールを接続する

GitHub
GitHub
必須
GitHub。ZeroがマージされたPR、コミットメッセージ、ラベル、リリースタグを読みます。リポジトリへの読み取り権限が必要です。
接続
Slack
Slack
必須
Slack。Zeroがレビューチャンネルにドラフトを届け、承認後に最終ノートを投稿します。チャンネルへの書き込み権限が必要です。
接続

ステップ2:Zeroに聞く

@Zero 今日出荷するリリースについて、前回のリリースタグ以降にマージされたPRをすべて読んで。顧客インパクトごとにグループ化して:新機能、改善、バグ修正。内部のリファクタリングとテスト変更はスキップして。我々のプロダクトボイスで顧客向けノートをドラフトして。
ZeroがリリースウィンドウのマージPRをすべて読む
Zeroが前回のリリースタグ以降にマージされたPRを、タイトル、説明、ラベルごと取得します。内部のみの変更(リファクタリング、テスト、CIの調整)はラベル規約に基づいてフィルタリングで除外されます。
Zeroが顧客インパクトごとに変更をグループ化
Zeroが残りのPRを新機能、改善、修正のテーマに分類します。各変更はPR説明から、顧客向けの1行に書き直されます。有用と言えるくらい具体的で、内部のジャーゴンは排除されます。
Zeroがあなたのプロダクトボイスでノートをドラフト
最終ドラフトは、あなたのリリースノートテンプレートに沿ったセクション構成で、ドキュメンテーションツールかSlackに届きます。ボイスとニュアンスを編集して公開するだけです。

ステップ3:さらに活用する

ボイスを洗練
Zeroが使うトーンとフォーマットのガイダンスを更新します。
@Zero 今後はリリースノートでMarkdownの見出しはスキップして。プレーンな文章のみで。
公開と連結
承認されたノートを、ドキュメントやブログへ直接プッシュします。
@Zero ノートを承認したら、ドキュメントのReleasesセクションに公開して、#announcements にリンクを投稿して。
翻訳
対応するすべてのロケール向けにノートを生成します。
@Zero 承認したリリースノートをドイツ語、日本語、スペイン語に翻訳して。セクション構造は維持して。

より良い結果のためのヒント

内部のみのPRには一貫したラベル(`internal` や `no-release-notes` など)を付けましょう。Zeroが除外できるのは、マークされたものだけです。
リリースノートの短いスタイルガイドをドキュメントに保管しましょう。顧客向けのボイス、能動態の動詞、内部ジャーゴンなし。Zeroがそれを読み取り、毎回のリリースに適用します。
リリース出荷後ではなく、出荷前にノートをドラフトしましょう。作業の記憶が新しいうちにレビューする方が、1週間後にコンテキストを再構築するより速く済みます。