事前準備
- この機能はヘルプセンターや製品ドキュメント用サイト向けに作られています。ソフトウェアまたはSaaSテンプレートでは初期状態で有効です。その他の種類のサイトには追加できません。
- ヘルプセンターの管理権限が必要です。
手順
- Storiesを開き、Release notesを選択します。リリースノートの一覧画面が開きます。
- Newを選択します。
- Title、
version、およびバージョンが公開された日付であるreleasedOnを入力します。この3つは入力必須です。 - 任意項目:最大1,000文字のSummary、詳細ページへのLinkを入力します。
- リスト欄に、変更点を1行ずつ追加します。フォーム上ではMomentsとして表示されます。そのKindとして、New、Improved、Fixedのいずれかを選びます。内容は最大300文字で入力してください。最大100行まで追加できます。
- 適切なハブのセクションにノートを配置し、公開します。
フォームでは、これらの入力欄が完全な文章ではなく、versionやreleasedOnのような短い名前で表示されます。
補足情報
- Order ノートは公開日が新しい順に表示されます。
- ハブごと。 各ハブのページには、自身のセクションやトピックに属するノートが一覧表示されます。
- RSS。 読者はチェンジログをフィードとして購読できます。フィードのURLは、サイトのアドレス末尾が /help/release-notes.rss となります。
- 検索データ。 各ノートは検索エンジンに対してバージョン情報を含む技術記事として伝達されます。ただし、検索結果での特別な表示が保証されるわけではありません。
- 読者目線で書く。 ユーザーにとって何が変わったのかを、わかりやすい言葉で伝えましょう。
よくある質問
よくある質問
リリースノートの予約投稿はできますか?
はい、可能です。リリースノートは記事と同じ形式のエントリなので、指定した日時に公開できます。
まだ修正されていない不具合はどうすればいいですか?
Known issues and noticesをご活用ください。