Files
Q-A_test/apps/docs/i18n/ja/docusaurus-plugin-content-docs/current/01-user-guide/01-getting-started.md
T
SDI 12e4f17b62
CI / typecheck (push) Successful in 1m8s
CI / format (push) Failing after 1m6s
CI / lint (push) Failing after 49s
CI / test (push) Failing after 1m8s
first commit
2026-07-15 18:05:12 +09:00

11 KiB
Raw Blame History

title, description, sidebar_position
title description sidebar_position
はじめに ABC User Feedbackインストール後、初期設定から最初のフィードバック収集まで、システムを開始する方法を説明します。 1

はじめに

ABC User Feedbackを初めてインストールした後、システムを使用するには初期設定が必要です。このドキュメントでは、テナント作成から最初のフィードバック収集までの全プロセスを段階的に説明します。


初期設定の概要

ABC User Feedbackを開始するには、次の順序で設定を進めます:

  1. テナントと管理者アカウントの作成
  2. 初回ログインとプロフィール設定
  3. プロジェクトの作成
  4. チャネルの作成とフィールド設定
  5. APIキーの発行
  6. 最初のフィードバック収集のテスト

システムへのアクセス

ABC User Feedbackのインストールが必要な場合は、まずDocker Hubイメージを使用したインストールを進めてください。

インストールを完了したら、Webブラウザを通じてABC User Feedbackにアクセスします:

http://localhost:3000

ポートやドメインを変更した場合は、設定に応じたアドレスを入力してください。


テナントと管理者アカウントの作成

member-register.png

初めてアクセスすると、テナント作成と管理者アカウント登録画面が表示されます。

Step 1: テナント情報の入力

テナント名を設定します。

テナント名を入力した後、Nextボタンをクリックします。

このテナント名はログインUIに表示されます。

Step 2: 管理者アカウントの作成

システムの最初の管理者アカウントを作成します。

  1. 管理者アカウントのメールアドレスを入力し、Request Codeボタンをクリックします。
  2. メールボックスで認証コードを確認して入力します
  3. Verifyボタンをクリックします
  4. 認証が完了したら、パスワードを設定します。

:::info パスワード要件

  • 8文字以上
  • 英字を含むAZ、az
  • 特殊文字を含む(例:@#!
  • 連続文字禁止(例:aa11

: MyCompany2024!, 12345678password

:::

テナントと管理者アカウントの作成が完了すると、確認画面が表示されます。

次のステップ: 確認ボタンをクリックしてログイン画面に移動します。


ログイン

作成した管理者アカウントで初回ログインを行います。

  1. Email: 先ほど登録した管理者メールアドレスを入力します
  2. Password: 設定したパスワードを入力します
  3. Sign Inボタンをクリックします

最初のプロジェクトの作成

ログインすると、プロジェクト作成ウィザードが自動的に開始されます。

システム構造の理解

ABC User Feedbackは、次の階層構造を持っています:

テナント(組織)
 └── プロジェクト(製品/サービス単位)
     └── チャネル(フィードバック収集パス)

Step 1: プロジェクト基本情報

項目 説明
Name プロジェクト名 モバイルアプリWebサービス
Description プロジェクトの説明(オプション) 顧客フィードバック収集と分析
Time Zone 時間基準(ダッシュボードと統計に影響) Asia/Tokyo

完了後: 情報を入力した後、Nextボタンをクリックします。

Step 2: チームメンバーの招待(オプション)

このステップでは、プロジェクトにチームメンバーを招待できます。今スキップしても、後でいつでも追加できます。

Step 3: APIキーの生成(オプション)

外部システムとの統合用のAPIキーを事前に生成できます。

プロジェクト作成完了

すべての情報を入力すると、プロジェクト作成が完了します。

次のステップを選択

  • Create Channel: すぐにチャネルを作成してフィードバック収集を開始
  • Skip for Now: 後でチャネルを作成

最初のチャネルの作成

プロジェクト作成後、実際にフィードバックを収集するにはチャネルを作成する必要があります。

チャネルの概念の理解

チャネルはフィードバック収集パスを意味します:

  • ウェブサイトのお問い合わせフォーム
  • モバイルアプリ内のフィードバック
  • カスタマーサービスVoC
  • アンケート回答

Step 1: チャネル基本情報

項目 説明
Name チャネル名 Webフィードバックアプリレビュー
Description チャネルの説明(オプション) ウェブサイトユーザーの意見
Maximum Feedback Search Period フィードバック検索可能期間(30/90/180/365日、すべて) 90日

完了後: 情報を入力した後、Nextボタンをクリックします。

Step 2: フィールド設定

チャネルで収集するデータ構造を定義します。

デフォルトフィールド

システムで自動的に作成されるフィールド:

フィールド名 形式 プロパティ 説明
id number Read Only フィードバック固有ID
createdAt date Read Only 作成時間
updatedAt date Read Only 更新時間
issues multiSelect Editable リンクされたイシューリスト

カスタムフィールドの追加

実際のフィードバック収集のためにカスタムフィールドを追加します:

  1. Add Fieldボタンをクリック
  2. フィールド情報を入力:
項目 説明
Key 一意の識別子(大文字/小文字、数字、_ messagerating
Display Name UIに表示される名前 フィードバック内容
Format データ形式 textkeywordnumberdateselectmultiSelectimagesaiField
Property EditableUIで変更可能)/ Read Only(変更不可) Editable
Status Active / Inactive Active

推奨デフォルトフィールド構成

最初のチャネルには、次のフィールドを追加することをお勧めします:

Key Display Name Format 説明
message フィードバック内容 text ユーザーフィードバック
userEmail ユーザーメールアドレス keyword 連絡先(オプション)
rating 満足度 number 1-5点評価

フィールドプレビュー

フィールド設定を完了した後、Previewボタンでフィードバック入力画面をプレビューできます。

完了後: Completeボタンでチャネル作成を完了します。

チャネル作成完了

次のステップ: Startボタンをクリックしてフィードバック収集を開始します。


最初のフィードバック収集のテスト

チャネル作成が完了すると、実際にフィードバックを収集できます。

APIによるフィードバック登録

作成したAPIキーを使用して最初のフィードバックを登録してみましょう。

APIリクエスト例

curl -X POST http://localhost:4000/api/projects/1/channels/1/feedbacks \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{
    "message": "アプリの実行速度が遅いです",
    "userEmail": "user@example.com",
    "rating": 3
  }'

YOUR_API_KEYは、先ほど作成した実際のAPIキーに置き換えてください。

成功レスポンスの確認

APIリクエストが成功すると、次のようなレスポンスが返されます:

{
  "id": 1
}

フィードバックの確認

登録したフィードバックをWebインターフェースで確認してみましょう。

  1. 上部メニューでFeedbackタブをクリック
  2. フィードバックリストで登録されたフィードバックを確認
  3. フィードバックをクリックして詳細情報を確認

最初のイシューの作成

フィードバックに基づいてイシューを作成してみましょう。

  1. フィードバック詳細画面で、Issueセクションの**+ボタン**をクリック
  2. イシュー名を入力し、EnterキーまたはCreateボタンをクリック
  3. 作成されたイシューを確認

次のステップガイド

基本的な設定と最初のフィードバック収集が完了しました!

関連ドキュメント