| name | announcement |
| description | リリース後にアナウンス文のタイトルと本文を作成して notes/announcements/ 以下に Markdown ファイルとして保存する。機能追加や不具合対応が完了したあとに使う。 |
| argument-hint | [アナウンス対象の機能追加や不具合対応などの内容] |
| disable-model-invocation | true |
/announcement - アナウンス文作成ワークフロー
$ARGUMENTS の内容についてアナウンス文を作成し、notes/announcements/ 以下に Markdown ファイルとして保存する。
Phase 1: 情報収集
1-1. アナウンス内容の確認
1-2. 関連 Issue / PR の確認
1-3. 画像の確認
Phase 2: アナウンス文の作成
対象読者
ソフトウェア開発者だけでなく、日本の小学校・中学校でプログラミングを教える先生。
文体・トーン
- 親しみやすく前向きなトーン
- 機能の説明は平易な言葉で、先生がすぐ理解できるように書く
- 専門用語は「技術的な仕組み(興味がある人向け)」セクションにまとめる
タイトルのフォーマット
- 日本語で「何が変わったか」が一読でわかるようにする
- 末尾に絵文字を付ける(内容に合ったもの: 🎉 🚀 🎓 🎮 など)
- 例:
Rubyタブがもっと便利に!ローカル変数とgetsメソッドに対応しました 🎉
本文のフォーマット(過去のアナウンス文に倣う)
<機能を一言で表す導入文(1〜2文)>
<変更点の概要を簡潔に>
## 🚀 <メインの新機能・変更点の見出し>
<先生向けの平易な説明>
<画像(スクリーンショット・動画)>
<ポイントをリストで整理>
---
## ▶️ <2つ目の機能があれば>
...
---
## 💡 技術的な仕組み(興味がある人向け)
<開発者向けの技術的な説明>
---
## 🔗 スモウルビーを試してみよう
<新機能を試すための誘導文。内容に合わせて変える>
**👉 [https://smalruby.app](https://smalruby.app)**
---
## 📚 詳細情報
実装の詳細や技術的な議論については、以下のIssueをご覧ください:
* [<タイトル> #<番号>](<URL>)
<締めくくりの一言>
強調表示(太字)のルール
**テキスト** は本当に重要なキーワードや固有名詞に限定する
- 多用しない。文中に太字が多いと感じたら減らす
- 斜体は基本的に使わない
画像の使い方
Phase 3: レビューと確認
- ドラフト(タイトルと本文)をユーザーに提示する
- 「このアナウンス文でよいですか?修正が必要な点があればお知らせください。」と確認する
- 画像が足りないと判断したら、具体的に何の画像が必要かリクエストする:
以下の箇所に画像を追加すると、先生方にとってよりわかりやすくなると思います:
- [セクション名]: [どのような画像が必要か]
追加でスクリーンショットを撮っていただけますか?
- 強調表示(太字)が多すぎないか確認する
- ユーザーの明示的な承認(「OK」「保存して」など)を得てから Phase 4 へ進む
Phase 4: ファイルへの保存
保存先
notes/announcements/ ディレクトリ以下に Markdown ファイルとして保存する。
- ファイル名はアナウンス内容を表す kebab-case の英語名にする(例:
prism-migration.md、ruby-tab-toolbar.md)
- ディレクトリが存在しない場合は作成する
ファイルフォーマット
# タイトル案
<タイトル>
---
# 本文案
<本文>
---
## 🔗 スモウルビーを試してみよう
<新機能についての誘導文>
**👉 [https://smalruby.app](https://smalruby.app)**
---
## 💬 ご意見・ご質問をお待ちしています
もしスモウルビーを使っていて、これまでと動きが違う、この動きは期待したものと違う、などなど、気になる点があれば **気軽に contact @ smalruby.jp までご連絡ください**。
一年に数件しか問い合わせがないので、さみしいくらいの状況ですので、本当に、遠慮なく、ご連絡ください。
## ⭐ GitHub Starで応援してください
スモウルビーの開発を応援してくださる方は、ぜひGitHubリポジトリにStarをつけてください!
**👉 [smalruby/smalruby3-editor](https://github.com/smalruby/smalruby3-editor)** にアクセスして、右上の「Star」ボタンをクリックするだけです。
皆さまの応援が、開発の大きな励みになります!
画像プレースホルダー
画像 URL はユーザーが GitHub にアップロード後に手動で差し替えるため、ファイル内では以下のようにコメントで目印を入れる:
<!-- 画像をここに挿入: [どのような画像か] -->
<!-- 例: <img width="..." height="..." alt="説明" src="(URL)" /> -->
保存後のアクション
- 保存したファイルパスをユーザーに伝える
- 「画像をアップロードしてURLが取得できたら、コメント部分をURLに差し替えてから GitHub Discussions に投稿してください。」と案内する
DoD(完了の定義)
参考: 過去のアナウンス文