|
| 1 | +# Issue Report Components |
| 2 | + |
| 3 | +## Overview |
| 4 | +This document outlines the implementation of specialized issue reporting components for the Transcriptr application to improve user experience when reporting problems. |
| 5 | + |
| 6 | +## Current State |
| 7 | +- Generic feedback form handles all feedback types including issues |
| 8 | +- UnsupportedFormatHelp component has basic GitHub issue reporting |
| 9 | +- Footer has "Report an Issue" link that opens generic feedback modal |
| 10 | + |
| 11 | +## Proposed Components |
| 12 | + |
| 13 | +### 1. ConversionErrorReporter |
| 14 | +**Purpose**: Specialized component for reporting audio conversion failures |
| 15 | +**Location**: `src/components/issue-reporting/ConversionErrorReporter.tsx` |
| 16 | +**Features**: |
| 17 | +- Pre-populated with conversion error details |
| 18 | +- Includes file format information |
| 19 | +- CloudConvert job ID (if available) |
| 20 | +- Automatic browser/OS detection |
| 21 | +- Direct integration with GitHub Issues API |
| 22 | + |
| 23 | +### 2. TranscriptionErrorReporter |
| 24 | +**Purpose**: Component for reporting transcription failures |
| 25 | +**Location**: `src/components/issue-reporting/TranscriptionErrorReporter.tsx` |
| 26 | +**Features**: |
| 27 | +- Pre-populated with transcription error details |
| 28 | +- Replicate job information |
| 29 | +- Audio file metadata |
| 30 | +- Error logs and stack traces |
| 31 | + |
| 32 | +### 3. PerformanceIssueReporter |
| 33 | +**Purpose**: Component for reporting performance problems |
| 34 | +**Location**: `src/components/issue-reporting/PerformanceIssueReporter.tsx` |
| 35 | +**Features**: |
| 36 | +- Performance metrics collection |
| 37 | +- Browser performance data |
| 38 | +- File size and processing time information |
| 39 | +- Memory usage statistics |
| 40 | + |
| 41 | +### 4. GeneralIssueReporter |
| 42 | +**Purpose**: Enhanced general issue reporting with better categorization |
| 43 | +**Location**: `src/components/issue-reporting/GeneralIssueReporter.tsx` |
| 44 | +**Features**: |
| 45 | +- Issue categorization dropdown |
| 46 | +- Template-based issue descriptions |
| 47 | +- Automatic environment information |
| 48 | +- Screenshot capture capability |
| 49 | + |
| 50 | +### 5. IssueReportManager |
| 51 | +**Purpose**: Central component to route different types of issues to appropriate reporters |
| 52 | +**Location**: `src/components/issue-reporting/IssueReportManager.tsx` |
| 53 | +**Features**: |
| 54 | +- Issue type detection and routing |
| 55 | +- Common issue templates |
| 56 | +- Progress tracking for issue submission |
| 57 | +- Follow-up communication handling |
| 58 | + |
| 59 | +## Integration Points |
| 60 | +- Replace UnsupportedFormatHelp issue reporting with ConversionErrorReporter |
| 61 | +- Enhance TranscriptionError component with TranscriptionErrorReporter |
| 62 | +- Update Footer issue reporting to use IssueReportManager |
| 63 | +- Add performance issue reporting to slow operations |
| 64 | + |
| 65 | +## Technical Requirements |
| 66 | +- TypeScript interfaces for issue data structures |
| 67 | +- Integration with GitHub Issues API |
| 68 | +- Error boundary integration |
| 69 | +- Analytics tracking for issue types |
| 70 | +- Rate limiting and spam prevention |
0 commit comments