📝 docs: Add documentation

2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
@@ -0,0 +1,131 @@
+<div v-pre>
+
+# Announcement Management
+
+Create and manage system announcements with display control, pinning, and popup features.
+
+## Table Column Description
+
+### Show
+Switch button to control whether the announcement displays on the frontend.
+
+### Pinned
+Switch button to control whether the announcement is pinned to top.
+
+### Popup
+Switch button to control whether to show announcement as popup when users visit.
+
+### Title
+Announcement title.
+
+### Content
+Announcement body content (supports Markdown).
+
+### Updated At
+Last update time.
+
+## Table Operations
+
+### Edit
+Opens side drawer form to modify announcement information.
+
+### Delete
+Deletes announcement (requires confirmation), cannot be recovered.
+
+### Batch Delete
+Deletes multiple selected announcements.
+
+## Announcement Form
+
+### Title (Required)
+Announcement title text.
+
+### Content (Required)
+Announcement body content, supports Markdown format:
+- Headings: # ## ###
+- Bold: **text**
+- Italic: *text*
+- Lists: - item
+- Links: [text](url)
+- Code: `code`
+
+## Filter Functions
+
+### Enable Filter
+- Show: View displayed announcements
+- Hide: View hidden announcements
+
+### Keyword Search
+Search announcements by title or content.
+
+## Usage Scenarios
+
+### Scenario 1: Create Important Notice
+
+**Form Config**:
+- Title: System Maintenance Notice
+- Content:
+  ```
+  # System Maintenance Notice
+
+  The system will undergo maintenance upgrade on **Jan 1, 2024 02:00-04:00**.
+
+  ## Affected Scope
+  - Website temporarily unavailable
+  - Services unaffected
+
+  Thank you for your understanding!
+  ```
+- Show: On
+- Pinned: On
+- Popup: On
+
+### Scenario 2: Create Activity Announcement
+
+**Form Config**:
+- Title: Double 11 Sale
+- Content:
+  ```
+  ## 🎉 Double 11 Sale
+
+  - All plans **20% OFF**
+  - Annual plans get extra **30 days**
+  - Period: 11.11-11.13
+
+  [Buy Now](/subscribe)
+  ```
+- Show: On
+- Pinned: On
+- Popup: No
+
+### Scenario 3: Create Usage Guide
+
+**Form Config**:
+- Title: Beginner's Guide
+- Content:
+  ```
+  # Beginner's Guide
+
+  ## 1. Purchase Plan
+  Go to [Subscribe Page](/subscribe) and select a plan
+
+  ## 2. Download Client
+  Visit [Documentation](/docs) to download client
+
+  ## 3. Import Config
+  Copy subscription link to client
+  ```
+- Show: On
+- Pinned: No
+- Popup: No
+
+## Important Notes
+
+1. **Markdown Support**: Content supports Markdown for beautiful formatting
+2. **Popup Feature**: When enabled, users see popup on every visit
+3. **Pinned Display**: Pinned announcements appear at top of list
+4. **Display Control**: Can create first, then enable display later
+5. **Batch Delete**: Delete operation irreversible, use carefully
+6. **Update Time**: Timestamp updates on every edit
+
+</div>
@@ -0,0 +1,155 @@
+<div v-pre>
+
+# Marketing Management
+
+Provides two major marketing functions: email marketing and quota services for batch user outreach and benefit distribution.
+
+## Function Modules
+
+### Email Marketing
+
+Contains two functions:
+
+#### 1. Email Broadcast
+
+Send marketing emails to users in bulk.
+
+**Form Fields**:
+
+- **Email Subject** (Required) - Email title
+- **Email Content** (Required) - Supports HTML editor for rich text emails
+- **Send Scope** - Select target user group:
+  - All users
+  - Users with subscriptions
+  - Users without subscriptions
+  - Filter by registration time
+- **Registration Time Range** (Optional) - Filter users registered in specific period
+- **Additional Emails** (Optional) - Manually input extra email addresses, one per line
+- **Scheduled Send** (Optional) - Set future send time
+- **Send Interval** (Optional) - Seconds between each email (minimum 0.1s)
+- **Daily Limit** (Optional) - Maximum sends per day (minimum 1)
+
+**Recipient Statistics**:
+Form displays in real-time:
+- System users count
+- Additional emails count
+- Total recipients count
+
+#### 2. Email Task Manager
+
+View and manage email sending tasks.
+
+**Task List Shows**:
+- Task ID
+- Subject
+- Send status
+- Sent count
+- Total count
+- Creation time
+
+**Task Operations**:
+- View details
+- Pause/Resume
+- Delete task
+
+### Quota Service
+
+Batch gift traffic, days, or balance to users.
+
+#### 1. Quota Broadcast
+
+Batch gift benefits to subscribed users.
+
+**Form Fields**:
+
+- **Select Packages** (Required) - Multi-select target product plans
+- **Subscription Status** - Filter condition:
+  - Active subscriptions only
+  - Include expired subscriptions
+- **Subscription Time Range** (Optional) - Filter users subscribed in specific period
+- **Reset Traffic** - Switch, whether to reset user traffic when gifting
+- **Gift Type** (Required) - Radio:
+  - Traffic (GB)
+  - Days
+  - Balance
+- **Gift Value** (Required) - Specific gift amount
+
+**Recipient Statistics**:
+Form displays qualifying user count in real-time.
+
+#### 2. Quota Task Manager
+
+View and manage quota distribution tasks.
+
+**Task List Shows**:
+- Task ID
+- Package names
+- Gift type and amount
+- Processing status
+- Processed/Total
+- Creation time
+
+**Task Operations**:
+- View details
+- Delete task
+
+## Usage Scenarios
+
+### Scenario 1: New User Welcome Email
+
+**Email Broadcast Config**:
+- Subject: Welcome!
+- Content: Design welcome email (HTML)
+- Scope: All users
+- Registration: Last 7 days
+- Interval: 1 second
+- Daily Limit: 1000
+
+### Scenario 2: Promotion Notification
+
+**Email Broadcast Config**:
+- Subject: Limited Time! 20% Off Annual Plans
+- Content: Activity details (HTML)
+- Scope: Users with subscriptions
+- Scheduled: 1 hour before activity
+
+### Scenario 3: Gift Traffic Benefit
+
+**Quota Broadcast Config**:
+- Packages: Standard Monthly
+- Status: Active only
+- Subscription Time: Past 30 days
+- Reset Traffic: No
+- Gift Type: Traffic
+- Gift Value: 10 GB
+
+### Scenario 4: Gift Membership Duration
+
+**Quota Broadcast Config**:
+- Packages: All packages
+- Status: Active only
+- Reset Traffic: No
+- Gift Type: Days
+- Gift Value: 7
+
+### Scenario 5: Balance Cashback
+
+**Quota Broadcast Config**:
+- Packages: Premium Plan
+- Status: Active only
+- Subscription Time: Past 7 days
+- Gift Type: Balance
+- Gift Value: $10
+
+## Important Notes
+
+1. **Email Sending**: Watch interval and limits to avoid spam classification
+2. **HTML Content**: Emails support rich text for beautiful marketing content
+3. **Scheduled Tasks**: Can set future time for automatic sending
+4. **Real-time Stats**: Recipient count calculated in real-time, preview before submit
+5. **Task Management**: Can view task execution progress and status
+6. **Quota Gifting**: Quotas distributed immediately, cannot be revoked
+7. **Traffic Reset**: Checking will reset user's current traffic
+8. **Package Filtering**: Can precisely select target user groups
+
+</div>