ユーザーガイドヘルプを作成

ユーザーガイドのヘルプドキュメントは、ページの適切なセクションにグループ化され、構成可能な順序で一覧表示されます。セクションをヘルプページに追加します。

始める前に

セクションレコード内からすべてのヘルプドキュメントを作成します。これにより、タイトルを絞り込み、配置を調整し、セクションに適しているかどうかを判断できます。

必要なロール：admin

手順

1. ページを作成します。
   1. 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページ をクリックし、[ 新規] をクリックします。
   2. フォームを完了します。

      表 : 1. ヘルプページのフィールド定義

      フィールド	説明
      ID	ヘルプ URL を作成するためにシステムによって使用されるページ ID。
      アプリケーション	このヘルプページのアプリケーションスコープ。このフィールドは読み取り専用で、デフォルトは グローバル スコープです。
      タイトル	このページのタイトルを表示します。

   3. [Submit (送信)] を選択します。

      

2. ヘルプページセクションを作成し、ページに関連付けます。
   1. 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページセクション をクリックし、[ 新規] をクリックします。

      

   2. セクションに一意で簡潔なタイトルを付けて、[ 送信] をクリックします。
      ビューがセクションのリストに戻ります。
   3. ヘルプページの追加セクションを作成します。
   4. 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページ をクリックし、新しいページを開きます。
   5. [ページからセクションへ] 関連リストで、[新規] をクリックします。
   6. フォームを完了します。

      表 : 2. ページからセクションへのフィールド定義

      フィールド	説明
      列	このセクションのページ上の列の位置。最初の列は 0 として指定され、2 番目の列は 1 として指定されます。セクションを表示するには、列 0 のエントリが少なくとも 1 つ必要です。
      順序	ページの列にセクションが表示される順序。順序番号が定義されていない場合、セクションはアルファベット順にリストされます。
      アプリケーション	このレコードのアプリケーションスコープ。このフィールドは読み取り専用で、デフォルトは グローバル スコープです。
      ページ	このセクションが表示されるヘルプページ。ルックアップフィールドを使用して、セクションが表示されるページを変更できます。
      セクション	選択したページに表示するセクションの名前。

      

   7. [Submit (送信)] を選択します。
   8. オプション: 必要に応じてヘルプページにセクションを追加します。
3. 1 つ以上のドキュメントを作成します。
   1. 移動先 システムユーザーガイド > アドミニストレーション > ヘルプページセクション.
   2. 作成したセクションレコードを開きます。
   3. [ヘルプ] 関連リストで、[新規] をクリックして、そのセクションのヘルプドキュメントを作成します。
   4. フォームを完了します。

      表 : 3. ヘルプドキュメントフィールド定義

      フィールド	説明
      番号	システムによって自動的に生成されるドキュメント番号。
      セクション	このドキュメントが表示されるセクション。
      順序	選択したセクションにおけるこのドキュメントの表示順序。
      公開済み	このドキュメントが作成された日付。
      更新日時	このドキュメントの最終更新日。
      簡単な説明	このドキュメントの内容の簡単な説明。この説明は、ヘルプページのドキュメントのタイトルとして使用されます。
      テキスト	グラフィックやテーブルなどのドキュメントコンテンツ。エントリの書式設定、箇条書きや番号付きリストの作成、画像の添付を行うことができます。

      

   5. [Submit (送信)] を選択します。
   6. このプロセスを繰り返して、そのセクションに必要なヘルプドキュメントを作成します。