ユーザーガイドヘルプを作成
ユーザーガイドのヘルプドキュメントは、ページ上の適切なセクションにグループ化され、構成可能な順序でリストされます。セクションをヘルプページに追加します。
始める前に
必要なロール：admin
手順
-
ページを作成します。
- 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページ をクリックし、[ 新規] をクリックします。
-
フォームに入力します。
表 : 1. ヘルプページのフィールド定義 フィールド 説明 ID ヘルプ URL を作成するためにシステムで使用されるページ ID。 アプリケーション このヘルプページのアプリケーションスコープ。このフィールドは読み取り専用で、デフォルトは グローバル スコープです。 タイトル このページのタイトルを表示します。 - [送信] をクリックします。
-
ヘルプページセクションを作成し、ページに関連付けます。
- 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページセクション をクリックし、[ 新規] をクリックします。
-
セクションに一意で簡潔なタイトルを付け、[ 送信] をクリックします。
ビューがセクションのリストに戻ります。
- ヘルプページに追加のセクションを作成します。
- 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページ をクリックして新しいページを開きます。
- [ ページからセクション] 関連リストで、[ 新規] をクリックします。
-
フォームに入力します。
表 : 2. [ページからセクション] フィールドの定義 フィールド 説明 列 このセクションのページ上の列の場所。最初の列は 0 として指定され、2 番目の列は 1 として指定されます。セクションを表示するには、列 0 に少なくとも 1 つのエントリが必要です。 順序 ページの列にセクションを表示する順序。順序番号が定義されていない場合、セクションはアルファベット順にリストされます。 アプリケーション このレコードのアプリケーションスコープこのフィールドは読み取り専用で、デフォルトは グローバル スコープです。 ページ このセクションが表示されるヘルプページ。ルックアップフィールドを使用して、セクションが表示されるページを変更できます。 セクション 選択したページに表示するセクションの名前。 - [送信] をクリックします。
- オプション: 必要に応じてヘルプページにセクションを追加します。
-
1 つ以上のドキュメントを作成します。
- 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページセクション.
- 作成したセクションレコードを開きます。
- [ヘルプ] 関連リストで、[新規] をクリックして、そのセクションのヘルプドキュメントを作成します。
-
フォームに入力します。
表 : 3. ヘルプドキュメントフィールドの定義 フィールド 説明 番号 システムによって自動的に生成されたドキュメント番号。 セクション このドキュメントが表示されるセクション。 順序 選択したセクションでのこのドキュメントのリスト順序。 公開済み このドキュメントが作成された日付。 更新日時 このドキュメントが最後に更新された日付。 簡単な説明 このドキュメントのコンテンツの簡単な説明。この説明は、ヘルプページのドキュメントのタイトルとして使用されます。 テキスト グラフィックや表を含むドキュメントコンテンツ。エントリーの書式を設定したり、箇条書きや番号付きリストを作成したり、画像を添付したりできます。 - [送信] をクリックします。
- このプロセスを繰り返して、そのセクションに必要なヘルプドキュメントを作成します。