first commit
This commit is contained in:
SDI
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
slug: /
|
||||
---
|
||||
|
||||
# ようこそ
|
||||
|
||||
ようこそ！このドキュメントは、ABC User Feedbackに関する包括的なガイドを提供します。
|
||||
|
||||
|
||||
|
||||
## ABC User Feedbackとは？
|
||||
|
||||
ABC User Feedbackは、顧客の声（VoC）フィードバックを効率的に収集、分類、管理するために設計されたスタンドアロンのWebアプリケーションです。フィードバックタギングシステム、カンバンモード、イシュートラッカー、SSO認証など、さまざまな機能を提供します。現在、1,000万MAUを有するサービスで利用されています。
|
||||
|
||||
<p align="center">
|
||||
<video src="https://github.com/user-attachments/assets/a2ef7a1a-41ec-4cec-b7d1-bda5fbd7d48b" width="100%" />
|
||||
</p>
|
||||
|
||||
## 主な機能
|
||||
|
||||
- **フィードバックタギングシステム**: トピック別にフィードバックを分類・管理
|
||||
- **カンバンモード**: イシューグループを効率的に視覚化・管理
|
||||
- **イシュートラッカー統合**: ステータスインジケーターでイシューを追跡し、外部システムと統合
|
||||
- **シングルサインオン（SSO）**: エンタープライズレベルの認証要件をサポートするOAuth認証
|
||||
- **ロールベースアクセス制御（RBAC）**: きめ細かいユーザー権限管理
|
||||
- **ダッシュボード**: フィードバックとイシューの統計データを視覚化
|
||||
|
||||
## はじめに
|
||||
|
||||
- [インストールガイド](/ja/developer-guide/installation/docker-hub-images) - Docker、CLIツール、または手動セットアップによるインストール方法
|
||||
- [チュートリアル](/ja/user-guide/getting-started) - 基本的な使用方法ガイド
|
||||
|
||||
## サポートを受ける
|
||||
|
||||
質問がある、またはヘルプが必要ですか？以下のリソースをご利用ください：
|
||||
|
||||
- [GitHub Issues](https://github.com/line/abc-user-feedback/issues) - バグレポートと機能リクエスト
|
||||
- [GitHub Discussions](https://github.com/line/abc-user-feedback/discussions) - コミュニティディスカッション
|
||||
|
||||
+75
@@ -0,0 +1,75 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "プロジェクト概要"
|
||||
description: "プロジェクト概要を紹介します。"
|
||||
---
|
||||
|
||||
# プロジェクト概要
|
||||
|
||||
## ABC User Feedbackとは？
|
||||
|
||||
ABC User Feedbackは、顧客の声（Voice of Customer、VoC）を効率的に収集、分類、管理するために設計されたスタンドアロンのWebアプリケーションです。このオープンソースソリューションは、ユーザーフィードバックを体系的に管理し、製品とサービスの改善に必要なインサイトを導き出すことに重点を置いています。
|
||||
|
||||
現在、このアプリケーションは月間アクティブユーザー（MAU）1,000万人規模のサービスで利用されており、大規模なフィードバック処理に対する実証済みの安定性を備えています。
|
||||
|
||||
## コアバリュー提案
|
||||
|
||||
ABC User Feedbackは、以下のコアバリューを提供します：
|
||||
|
||||
1. **中央集約型フィードバック管理**: さまざまなチャネルから収集されたユーザーフィードバックを一箇所で管理
|
||||
2. **構造化された分析**: イシューシステムを通じたフィードバックの分類とトレンドの把握
|
||||
3. **イシュー追跡**: フィードバックで発見された問題点をイシューに変換して追跡管理
|
||||
4. **データ駆動型意思決定**: ダッシュボードを通じたフィードバックデータの視覚化とインサイトの導出
|
||||
|
||||
## 技術スタック
|
||||
|
||||
ABC User Feedbackは、最新のWeb技術に基づいて構築されています：
|
||||
|
||||
- **フロントエンド**: [Next.js](https://nextjs.org/) - Reactベースのフロントエンドフレームワーク
|
||||
- **バックエンド**: [NestJS](https://nestjs.com/) - TypeScriptベースのスケーラブルなバックエンドフレームワーク
|
||||
- **データベース**: [MySQL v8](https://www.mysql.com/) - 信頼性の高いリレーショナルデータベース
|
||||
- **検索エンジン**: [OpenSearch v2.16](https://opensearch.org/)（オプション） - 大量のフィードバックデータに対する高性能検索機能
|
||||
|
||||
## アーキテクチャ概要
|
||||
|
||||
ABC User Feedbackは、以下の主要コンポーネントで構成されています：
|
||||
|
||||
1. **Web管理インターフェース**: フィードバック管理、イシュー追跡、ダッシュボードなどのユーザーインターフェースを提供するNext.jsベースのWebアプリケーション
|
||||
2. **APIサーバー**: データ処理、ビジネスロジック、認証などを担当するNestJSベースのバックエンドサーバー
|
||||
3. **データベース**: フィードバック、イシュー、ユーザー情報などを保存するMySQLデータベース
|
||||
4. **検索エンジン**: 大量のフィードバックデータに対する高性能検索を提供するOpenSearch（オプション）
|
||||
5. **SMTPサーバー**: アカウント作成時のメール認証、パスワードリセットなど、ユーザー認証プロセスに必要なメール送信を担当するコンポーネント
|
||||
|
||||
これらのコンポーネントは、Dockerを通じてコンテナ化されており、簡単にデプロイおよびスケールできます。
|
||||
|
||||
## 主な使用例
|
||||
|
||||
ABC User Feedbackは、以下の状況で特に有用です：
|
||||
|
||||
1. **製品改善プロセス**: ユーザーフィードバックを収集・分析して製品改善の方向性を設定
|
||||
2. **カスタマーサポート**: ユーザーの問い合わせとイシューを効率的に追跡・管理
|
||||
3. **ユーザー体験の最適化**: ユーザーの意見に基づいてUX/UIを改善
|
||||
4. **品質管理**: バグレポートと機能リクエストを体系的に管理
|
||||
5. **データ駆動型意思決定**: ユーザーフィードバック統計を活用した戦略的意思決定のサポート
|
||||
|
||||
## 差別化要素
|
||||
|
||||
ABC User Feedbackは、以下の特徴により、他のフィードバック管理ツールと差別化されています：
|
||||
|
||||
1. **完全なオープンソース**: 商用ソリューションとは異なり、完全に無料で使用でき、カスタマイズ可能
|
||||
2. **エンタープライズレベルの機能**: SSO認証、RBACなど、企業環境に必要な機能を提供
|
||||
3. **スケーラビリティ**: 大規模なユーザーベース（1,000万MAU）で実証されたパフォーマンス
|
||||
4. **統合の容易さ**: RESTful APIとWebhookによる既存システムとの簡単な統合
|
||||
5. **コンテナ化**: Dockerサポートによる簡単なデプロイとスケーリング
|
||||
|
||||
## 次のステップ
|
||||
|
||||
ABC User Feedbackを始めるには、以下のドキュメントを参照してください：
|
||||
|
||||
- [主な機能](./02-key-features.md) - 詳細な機能説明
|
||||
- [インストールガイド](/ja/developer-guide/installation/docker-hub-images) - インストール方法
|
||||
|
||||
---
|
||||
|
||||
このドキュメントは、ABC User Feedbackの基本的な概要を提供します。より詳細な情報については、該当セクションのドキュメントを参照してください。
|
||||
|
||||
+173
@@ -0,0 +1,173 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: '主な機能'
|
||||
description: '主な機能の紹介。'
|
||||
---
|
||||
|
||||
# 主な機能
|
||||
|
||||
ABC User Feedbackは、ユーザーフィードバックを効果的に収集、管理、分析するための様々な機能を提供します。このドキュメントでは、コア機能について詳しく説明します。
|
||||
|
||||
## フィードバックタグシステム
|
||||
|
||||
|
||||
|
||||
フィードバックタグシステムは、大量のユーザーフィードバックを体系的に分類・管理するためのコア機能です。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **複数イシューの割り当て**:各フィードバックに複数のイシューを割り当てて多次元的に分類
|
||||
- **カスタムイシューの作成**:プロジェクトの特性に合わせたカスタマイズされたイシューの作成と管理
|
||||
- **イシュー別フィルタリング**:イシュー別にフィードバックをフィルタリングして特定のトピックに集中
|
||||
- **イシュー統計**:イシューの使用頻度とトレンド分析による洞察の導出
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. 管理パネルでイシューカテゴリとイシューを作成
|
||||
2. 受信したフィードバックに関連イシューを割り当て
|
||||
3. イシュー別にフィードバックをフィルタリングして分析
|
||||
4. イシューの使用パターンから主要なイシューとトレンドを特定
|
||||
|
||||
## カンバンモード
|
||||
|
||||
|
||||
|
||||
カンバンモードは、イシューグループを視覚的に管理し、ワークフローを最適化するための機能です。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **直感的なドラッグ&ドロップ**:イシューのステータス変更のためのシンプルなインターフェース
|
||||
- **ステータスベースのカラム構成**:イシューの進行状況に基づくカラム分離(例:To Do、In Progress、Done)
|
||||
- **ワークフローの可視化**:チームの作業プロセスと進捗を一目で把握
|
||||
- **作業負荷管理**:各ステータスのイシュー数を通じた作業負荷のモニタリング
|
||||
- **フィルタとソート**:カンバンボード内のイシューを様々な基準でフィルタリング・ソート
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. カンバンモードビューを選択
|
||||
2. ステータス別にイシューを確認・管理
|
||||
3. ドラッグ&ドロップでイシューのステータスを変更
|
||||
4. チームのワークフローを最適化し、ボトルネックを特定
|
||||
|
||||
## イシュートラッカー連携
|
||||
|
||||
|
||||
|
||||
イシュートラッカー連携は、フィードバックで発見された問題や改善事項を体系的に管理するための機能です。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **ステータスインジケーター**:イシューの現在のステータスを視覚的に表示(New、In Progress、Resolvedなど)
|
||||
- **外部システム連携**:イシュートラッカーシステム(JIRA)との接続
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. フィードバックからイシューを作成、またはイシューメニューで作成
|
||||
2. 外部イシュートラッカー接続を設定(オプション)
|
||||
3. イシューの詳細とイシュー追跡チケットを設定
|
||||
4. イシューの進捗をモニタリング・更新
|
||||
5. 解決後にイシューをクローズ
|
||||
|
||||
## シングルサインオン(SSO)
|
||||
|
||||
|
||||
|
||||
シングルサインオンは、企業環境での認証プロセスを簡素化し、セキュリティを強化します。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **OAuthサポート**:様々なOAuthプロバイダーを通じた認証サポート
|
||||
- **企業IDとの統合**:既存の企業IDシステムとのシームレスな統合
|
||||
- **一元化されたユーザー管理**:単一の認証システムを通じたユーザーアクセス管理
|
||||
- **セキュリティの強化**:多要素認証と企業セキュリティポリシーの適用
|
||||
- **簡素化されたログイン体験**:ユーザーが追加アカウントを作成する必要がない
|
||||
|
||||
### サポートされるSSOプロバイダー
|
||||
|
||||
- Google
|
||||
- カスタム(標準的なOAuth 2.0およびOpenID Connectプロバイダー)
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. 管理設定でSSOプロバイダーを設定
|
||||
2. 認証パラメータとリダイレクトURLを設定
|
||||
3. ユーザー属性マッピングを設定
|
||||
4. SSOログインを有効化してテスト
|
||||
|
||||
## ロールベースアクセス制御(RBAC)
|
||||
|
||||
|
||||
|
||||
ロールベースアクセス制御は、ユーザー権限を効果的に管理し、システムセキュリティを維持するための機能です。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **事前定義されたロール**:管理者、アナリスト、閲覧者などの基本ロールを提供
|
||||
- **カスタムロールの作成**:組織構造に合わせたカスタマイズされたロールと権限の作成
|
||||
- **詳細な権限制御**:機能とデータ別にアクセス権限を設定
|
||||
- **ロール割り当て管理**:ユーザーごとにロールを割り当て・変更
|
||||
- **権限の継承**:階層的な権限構造をサポート
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. 管理パネルでロール管理メニューにアクセス
|
||||
2. 必要に応じて新しいロールを作成、または既存のロールを修正
|
||||
3. ユーザーに適切なロールを割り当て
|
||||
4. ロール別の権限とアクセス範囲を定期的にレビュー
|
||||
|
||||
## ダッシュボード
|
||||
|
||||
|
||||
|
||||
ダッシュボードは、フィードバックデータを可視化し、重要な洞察を一目で理解できる機能です。
|
||||
|
||||
### 主な機能
|
||||
|
||||
- **リアルタイム統計**:フィードバック数、イシュー数、解決率などの主要指標をリアルタイム表示
|
||||
- **トレンド分析**:時間経過によるフィードバックとイシューのトレンドをグラフで表示
|
||||
- **イシュー分布**:イシュー別のフィードバック分布を可視化
|
||||
|
||||
### 提供されるチャートとウィジェット
|
||||
|
||||
1. **フィードバックサマリーカード**:総フィードバック数、新規フィードバック、処理済みフィードバックなどの主要指標
|
||||
2. **時系列グラフ**:日次/週次/月次のフィードバックトレンド
|
||||
3. **イシューステータスドーナツチャート**:イシューステータス別の分布
|
||||
|
||||
### 使用方法
|
||||
|
||||
1. ダッシュボードページにアクセス
|
||||
2. 期間とフィルター設定を通じてデータ範囲を調整
|
||||
3. 主要指標とトレンドを分析
|
||||
4. 洞察に基づいた意思決定とアクションアイテムを導出
|
||||
|
||||
## 追加機能
|
||||
|
||||
上記の主要機能に加えて、ABC User Feedbackは以下の追加機能を提供します:
|
||||
|
||||
### API連携
|
||||
|
||||
- RESTful APIを通じた外部システムとの統合
|
||||
- プログラムによるフィードバック収集と管理
|
||||
|
||||
### Webhook
|
||||
|
||||
- 主要イベント発生時に外部システムに通知
|
||||
- 自動化されたワークフローの構築をサポート
|
||||
|
||||
### 画像ストレージ連携
|
||||
|
||||
- S3互換ストレージを通じたユーザー提出画像の管理
|
||||
- フィードバックへのスクリーンショットと画像の添付
|
||||
|
||||
### データエクスポート
|
||||
|
||||
- CSV、Excel形式でのフィードバックデータのエクスポート
|
||||
|
||||
### 多言語サポート
|
||||
|
||||
- 様々な言語でのインターフェース提供
|
||||
- 国際チーム向けの多言語フィードバック管理
|
||||
|
||||
---
|
||||
|
||||
このドキュメントは、ABC User Feedbackの主な機能の概要を提供します。各機能の詳細な使用方法については、[ユーザーガイド](/user-guide/getting-started)セクションを参照してください。
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"position": 1,
|
||||
"label": "紹介"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user