first commit

2026-07-15 18:05:12 +09:00
commit 12e4f17b62
4633 changed files with 817125 additions and 0 deletions
@@ -0,0 +1,40 @@
+---
+sidebar_position: 1
+slug: /
+---
+
+# Welcome
+
+Welcome! This documentation provides a comprehensive guide to ABC User Feedback.
+
+![ABC User Feedback](/assets/cover.png)
+
+## What is ABC User Feedback?
+
+ABC User Feedback is a standalone web application designed to efficiently collect, classify, and manage Voice of Customer (VoC) feedback. It provides various features including a feedback tagging system, kanban mode, issue tracker, SSO authentication, and more. It is currently being used in a service with 10 million MAU.
+
+<p align="center">
+  <video src="https://github.com/user-attachments/assets/a2ef7a1a-41ec-4cec-b7d1-bda5fbd7d48b" width="100%" />
+</p>
+
+## Key Features
+
+- **Feedback Tagging System**: Classify and manage feedback by topic
+- **Kanban Mode**: Efficiently visualize and manage issue groups
+- **Issue Tracker Integration**: Track issues with status indicators and integrate with external systems
+- **Single Sign-On (SSO)**: OAuth authentication supporting enterprise-grade authentication requirements
+- **Role-Based Access Control (RBAC)**: Granular user permission management
+- **Dashboard**: Visualize statistical data for feedback and issues
+
+## Getting Started
+
+- [Installation Guide](/en/developer-guide/installation/docker-hub-images) - Installation methods using Docker, CLI tools, or manual setup
+- [Tutorial](/en/user-guide/getting-started) - Basic usage guide
+
+## Get Support
+
+Have questions or need help? Check out these resources:
+
+- [GitHub Issues](https://github.com/line/abc-user-feedback/issues) - Bug reports and feature requests
+- [GitHub Discussions](https://github.com/line/abc-user-feedback/discussions) - Community discussions
+
@@ -0,0 +1,75 @@
+---
+sidebar_position: 1
+title: "Project Overview"
+description: "Introducing the project overview."
+---
+
+# Project Overview
+
+## What is ABC User Feedback?
+
+ABC User Feedback is a standalone web application designed to efficiently collect, classify, and manage Voice of Customer (VoC). This open-source solution focuses on systematically managing user feedback to derive insights needed for product and service improvements.
+
+Currently, this application is being used in a service with 10 million Monthly Active Users (MAU), demonstrating proven stability for large-scale feedback processing.
+
+## Core Value Proposition
+
+ABC User Feedback provides the following core values:
+
+1. **Centralized Feedback Management**: Manage user feedback collected from various channels in one place
+2. **Structured Analysis**: Classify feedback and identify trends through the issue system
+3. **Issue Tracking**: Convert problems found in feedback into issues and track them
+4. **Data-Driven Decision Making**: Visualize feedback data and derive insights through dashboards
+
+## Technology Stack
+
+ABC User Feedback is built on modern web technologies:
+
+- **Frontend**: [Next.js](https://nextjs.org/) - React-based frontend framework
+- **Backend**: [NestJS](https://nestjs.com/) - Scalable backend framework based on TypeScript
+- **Database**: [MySQL v8](https://www.mysql.com/) - Reliable relational database
+- **Search Engine**: [OpenSearch v2.16](https://opensearch.org/) (Optional) - High-performance search functionality for large amounts of feedback data
+
+## Architecture Overview
+
+ABC User Feedback consists of the following main components:
+
+1. **Web Admin Interface**: Next.js-based web application providing user interfaces for feedback management, issue tracking, dashboards, etc.
+2. **API Server**: NestJS-based backend server handling data processing, business logic, authentication, etc.
+3. **Database**: MySQL database storing feedback, issues, user information, etc.
+4. **Search Engine**: OpenSearch (optional) providing high-performance search for large amounts of feedback data
+5. **SMTP Server**: Component responsible for sending emails required for user authentication processes such as email verification during account creation and password reset
+
+These components are containerized through Docker, making them easy to deploy and scale.
+
+## Main Use Cases
+
+ABC User Feedback is particularly useful in the following situations:
+
+1. **Product Improvement Process**: Collect and analyze user feedback to set product improvement directions
+2. **Customer Support**: Efficiently track and manage user inquiries and issues
+3. **User Experience Optimization**: Improve UX/UI based on user opinions
+4. **Quality Management**: Systematically manage bug reports and feature requests
+5. **Data-Driven Decision Making**: Support strategic decision-making using user feedback statistics
+
+## Differentiators
+
+ABC User Feedback differentiates itself from other feedback management tools with the following features:
+
+1. **Fully Open Source**: Unlike commercial solutions, it's completely free to use and customizable
+2. **Enterprise-Grade Features**: Provides features needed for enterprise environments such as SSO authentication and RBAC
+3. **Scalability**: Proven performance in large-scale user base (10 million MAU)
+4. **Easy Integration**: Easy integration with existing systems through RESTful API and webhooks
+5. **Containerization**: Easy deployment and scaling with Docker support
+
+## Next Steps
+
+To get started with ABC User Feedback, refer to the following documents:
+
+- [Key Features](./02-key-features.md) - Detailed feature descriptions
+- [Installation Guide](/en/developer-guide/installation/docker-hub-images) - Installation methods
+
+---
+
+This document provides a basic overview of ABC User Feedback. For more detailed information, refer to the documents in the relevant sections.
+
@@ -0,0 +1,173 @@
+---
+sidebar_position: 3
+title: 'Key Features'
+description: 'Introducing key features.'
+---
+
+# Key Features
+
+ABC User Feedback provides various features to effectively collect, manage, and analyze user feedback. This document describes the core features in detail.
+
+## Feedback Tagging System
+
+![Feedback Tag](/assets/01-feedback-tag.png)
+
+The feedback tagging system is a core feature for systematically classifying and managing large amounts of user feedback.
+
+### Key Features
+
+- **Multiple Issue Assignment**: Assign multiple issues to each feedback for multidimensional classification
+- **Custom Issue Creation**: Create and manage customized issues tailored to project characteristics
+- **Issue-Based Filtering**: Filter feedback by issue to focus on specific topics
+- **Issue Statistics**: Derive insights through analysis of issue usage frequency and trends
+
+### How to Use
+
+1. Create issue categories and issues in the admin panel
+2. Assign relevant issues to received feedback
+3. Filter and analyze feedback by issue
+4. Identify key issues and trends through issue usage patterns
+
+## Kanban Mode
+
+![Issue Kanban](/assets/02-Issue-Kanban.png)
+
+Kanban mode is a feature for visually managing issue groups and optimizing workflows.
+
+### Key Features
+
+- **Intuitive Drag and Drop**: Simple interface for changing issue status
+- **Status-Based Column Configuration**: Column separation based on issue progress status (e.g., To Do, In Progress, Done)
+- **Workflow Visualization**: Understand team work processes and progress at a glance
+- **Workload Management**: Monitor workload through the number of issues in each status
+- **Filter and Sort**: Filter and sort issues in the kanban board by various criteria
+
+### How to Use
+
+1. Select kanban mode view
+2. Check and manage issues by status
+3. Change issue status with drag and drop
+4. Optimize team workflows and identify bottlenecks
+
+## Issue Tracker Integration
+
+![Issue Tracker](/assets/03-issue-tracker.png)
+
+Issue tracker integration is a feature for systematically managing problems or improvements found in feedback.
+
+### Key Features
+
+- **Status Indicators**: Visually display the current status of issues (New, In Progress, Resolved, etc.)
+- **External System Integration**: Connect with issue tracker systems (JIRA)
+
+### How to Use
+
+1. Create issues from feedback or in the issue menu
+2. Configure external issue tracker connection (optional)
+3. Set issue details and issue tracking ticket
+4. Monitor and update issue progress
+5. Close issue after resolution
+
+## Single Sign-On (SSO)
+
+![Single Sign-on](/assets/04-single-signon.png)
+
+Single Sign-On simplifies authentication processes in enterprise environments and enhances security.
+
+### Key Features
+
+- **OAuth Support**: Authentication support through various OAuth providers
+- **Enterprise ID Integration**: Seamless integration with existing enterprise ID systems
+- **Centralized User Management**: Manage user access through a single authentication system
+- **Enhanced Security**: Apply multi-factor authentication and enterprise security policies
+- **Simplified Login Experience**: No need for users to create additional accounts
+
+### Supported SSO Providers
+
+- Google
+- Custom (Standard OAuth 2.0 and OpenID Connect providers)
+
+### How to Use
+
+1. Configure SSO provider in admin settings
+2. Set authentication parameters and redirect URLs
+3. Configure user attribute mapping
+4. Enable and test SSO login
+
+## Role-Based Access Control (RBAC)
+
+![Role Management](/assets/05-role-management.png)
+
+Role-Based Access Control is a feature for effectively managing user permissions and maintaining system security.
+
+### Key Features
+
+- **Predefined Roles**: Provides basic roles such as Administrator, Analyst, Viewer
+- **Custom Role Creation**: Create customized roles and permissions tailored to organizational structure
+- **Granular Permission Control**: Set access permissions by function and data
+- **Role Assignment Management**: Assign and change roles per user
+- **Permission Inheritance**: Support hierarchical permission structures
+
+### How to Use
+
+1. Access role management menu in admin panel
+2. Create new roles or modify existing roles as needed
+3. Assign appropriate roles to users
+4. Regularly review permissions and access scope by role
+
+## Dashboard
+
+![Dashboard](/assets/06-dashboard.png)
+
+The dashboard is a feature that visualizes feedback data to understand important insights at a glance.
+
+### Key Features
+
+- **Real-time Statistics**: Real-time display of key metrics such as feedback count, issue count, resolution rate
+- **Trend Analysis**: Graphs showing feedback and issue trends over time
+- **Issue Distribution**: Visualization of feedback distribution by issue
+
+### Provided Charts and Widgets
+
+1. **Feedback Summary Cards**: Key metrics such as total feedback count, new feedback, processed feedback
+2. **Time Series Graphs**: Daily/weekly/monthly feedback trends
+3. **Issue Status Donut Chart**: Distribution by issue status
+
+### How to Use
+
+1. Access the dashboard page
+2. Adjust data range through period and filter settings
+3. Analyze key metrics and trends
+4. Derive insights-based decisions and action items
+
+## Additional Features
+
+In addition to the key features described above, ABC User Feedback provides the following additional features:
+
+### API Integration
+
+- Integration with external systems through RESTful API
+- Programmatic feedback collection and management
+
+### Webhooks
+
+- Notify external systems when major events occur
+- Support building automated workflows
+
+### Image Storage Integration
+
+- Manage user-submitted images through S3-compatible storage
+- Attach screenshots and images to feedback
+
+### Data Export
+
+- Export feedback data in CSV, Excel formats
+
+### Multi-Language Support
+
+- Provide interfaces in various languages
+- Multi-language feedback management for international teams
+
+---
+
+This document provides an overview of ABC User Feedback's key features. For more detailed usage of each feature, refer to the [User Guide](/en/user-guide/getting-started) section.
@@ -0,0 +1,5 @@
+{
+  "position": 1,
+  "label": "Introduction"
+}
+