HeroUI Pro リリースノート更新
概要
ユーザーが渡すドキュメントパスを確認し、最新のリリース情報を公式サイトから取得して追記する。
実行手順
Step 1: 既存ドキュメントを読む
ユーザーが渡したパスのドキュメントを読み、すでに記載されている最新バージョンを確認する。
Step 2: 公式リリース一覧を取得
https://heroui.pro/docs/react/releases
既存ドキュメントの最新バージョンより新しいリリースを特定する。
Step 3: 各リリースの詳細を取得
新しいリリースごとに以下の URL を取得する:
https://heroui.pro/docs/react/releases/beta-N
Step 4: 追記内容を作成する
新しいリリースを既存ドキュメントの**先頭(最新が上)**に追記する。
書き方のルール
書く内容・書かない内容
書く:
- 新しいコンポーネント・新機能(何が追加されたか)
- ユーザーストーリー視点での説明(何が作れるようになったか)
- 利用者に影響する破壊的変更(移行対応が必要なもの)
書かない:
- 細かいバグ修正
- 依存関係・peer dependency のバージョン変更
- ドキュメントの軽微な整理
文体・日本語のルール
- 「〜できるようになりました」「〜を作れます」という体で書く
- 英語の形容詞 + な + 日本語名詞 のパターンを使わない
- ❌
composable なカレンダーコンポーネント - ✓
部品ごとに組み合わせられるカレンダーコンポーネント
- ❌
- 英語をそのまま使わず、カタカナ化できるものはカタカナにする
- ❌
streaming 中は→ ✓ストリーミング中は - ❌
wrapper→ ✓ラッパー - ❌
tab order→ ✓タブ移動順 - ❌
viewport→ ✓表示領域
- ❌
- コード名(コンポーネント名・プロップ名)はバッククォートのまま残してよい
- サンプルコードは書かない
ユーザーストーリーの膨らませ方
単なる機能列挙でなく、「何が作れるようになったか」を添える。
例:
Agendaを紹介するなら「チームスケジューラ・施設予約・プロジェクトタイムラインのような、ドラッグ操作が中心のカレンダーアプリを作れます」- 新 AI コンポーネントなら「ChatGPT / Claude のような会話 UI や Perplexity のような引用付き検索 UI を HeroUI Pro だけで組めます」
- 実在するプロダクトや UI パターンを例示すると分かりやすい
セクション構成
## 1.0.0-beta.N(YYYY年M月)
詳細: https://heroui.pro/docs/react/releases/beta-N
### [機能名 or 追加コンポーネント名] — [一言で何ができるようになったかを見出しに]
[ユーザーストーリー視点の説明。何が作れるか・どんな場面で使えるか。]
- 箇条書きで詳細機能を列挙
### 注意が必要な変更(破壊的変更がある場合のみ)
[移行対応が必要な変更だけを記載]
参考ドキュメント
既存のリリースノートのスタイルを見れば記述基準が分かる。ユーザーが渡したドキュメント自体がリファレンスになる。