【サンプル】概要ページテンプレート

1. 〇〇 (メニュー名) を利用する前に

1.1. 始める前の準備

1.2. 〇〇のリソースとは

1.3. 〇〇コンソールとは

1.4. △△ (リソース) とは

1.5. 利用開始までの流れ

メニューを利用する上で前提として必要な準備 (利用環境など) や

知っておくべき基本概念 (管理手段や画面、リソースの名称と種類など)、

利用開始するまでに踏むべき手続き (ユーザ設定や権限設定など) について記載します。

概念の説明については「〇〇について」ではなく、「〇〇とは」という記載とすることで、

概念の説明であることが分かるようにしてください。

2. ××リソースを作成する

2.1. ××を購入する

2.2. △△を取得する

2.3. 〇〇を設定する

2.4. △△を変更する

2.5. ××リソースを削除する

3. ××サービスと接続する

3.1. ××を購入する

3.2. △△を取得する

3.3. 〇〇を接続する

3.4. △△を変更する

3.5. ××との接続を解除する

メニューを利用する上でユーザが利用する機能について、

機能とその利用シーン別に章を分けてチュートリアルを執筆します。

各章、小項目のタイトルは「〇〇機能について」ではなく、必ず「△△を××する」という動詞形で記述するようにしてください。

補足情報や注意が必要な情報について述べる場合はその限りではありませんが、その場合も

「××するために必要な〇〇について」や「△△する場合の〇〇について」という形で、

必ず情報が必要となるタイミングを明確化するようにしてください。

4. お困りの際は

よくあるケースとその対処方法をご紹介します。

4.1. xxを購入したが〇〇が出来ない

4.2. 〇〇の設定を変更すると△△が発生する

ユーザーからの問い合わせが頻発するようなケース、トラブルが発生しやすいことが事前に分かっているケースについて、

対処方法を示すことでユーザーの自己解決を支援します。

章のタイトルには必ずその事象が発生するタイミングや条件を明記してください。

「〇〇をしたいけど△△できない」、「××という状況で〇〇が発生してしまう」、など

5. お問い合せ

5.1. お問い合せいただく前に

5.2. お問い合せの流れ

5.3. チケットを作成する

5.4. チケットの回答を確認する

5.5. チケットの回答に返信する

ユーザーが問い合わせを行う際のチケット起票や確認の手順を記載します。

チケットを起票する際に運用保守担当が切り分けを行うために記載して欲しい情報

チケットの起票フォーマットの説明など、メニュー特有の情報を必ず記載するようにしてください。