611 lines
14 KiB
Markdown
611 lines
14 KiB
Markdown
# Section 5: HELP Module - Audit & Action Plan
|
|
|
|
**Date:** December 27, 2025
|
|
**Status:** Finalized for Implementation
|
|
**Scope:** Help Center, Documentation, Support Channels
|
|
|
|
---
|
|
|
|
## 5.1 Help & Docs
|
|
|
|
**Route:** `/help`
|
|
**File:** `pages/Help/HelpCenter.tsx`
|
|
|
|
### Current Functionality
|
|
- Table of Contents with jump-to-section navigation
|
|
- Getting Started: Quick Start Guide, Workflow Overview
|
|
- Planner Module: Keywords, Clusters, Ideas documentation
|
|
- Writer Module: Tasks, Content, Images documentation
|
|
- Automation Setup overview
|
|
- FAQ section (~20 questions)
|
|
- Support CTA buttons (non-functional)
|
|
|
|
---
|
|
|
|
### Issues to Address
|
|
|
|
| # | Issue | Priority | Action |
|
|
|---|-------|----------|--------|
|
|
| 1 | Support dropdown link broken | 🔴 Critical | Fix link - currently goes to `/profile` which is 404 |
|
|
| 2 | Contact Support button does nothing | 🔴 Critical | Implement mailto: or external support URL |
|
|
| 3 | Feature Request button does nothing | 🔴 Critical | Implement mailto: or external feedback URL |
|
|
| 4 | No actual support channel | 🔴 Critical | Configure working support email/system |
|
|
| 5 | Placeholder pages exist | High | **DELETE** `/help/docs`, `/help/system-testing`, `/help/function-testing` pages |
|
|
| 6 | No search functionality | Medium | Add search within help content |
|
|
| 7 | No contextual help | Low | Consider adding in-app tooltips or "?" icons (future) |
|
|
| 8 | Stale content risk | Medium | Help content is hardcoded in TSX - document update process |
|
|
|
|
---
|
|
|
|
### Pages to Delete
|
|
|
|
| File | Route | Reason |
|
|
|------|-------|--------|
|
|
| `pages/Help/Documentation.tsx` | `/help/docs` | Empty placeholder - not needed |
|
|
| `pages/Help/SystemTesting.tsx` | `/help/system-testing` | Empty placeholder - not needed |
|
|
| `pages/Help/FunctionTesting.tsx` | `/help/function-testing` | Empty placeholder - not needed |
|
|
|
|
---
|
|
|
|
## 5.2 Documentation Requirements (NEW)
|
|
|
|
### Documentation Approach
|
|
|
|
Create detailed, step-by-step documentation for each module and flow. Documentation should be:
|
|
- **Easy to use** - Clear language, no technical jargon
|
|
- **Step-by-step** - Numbered instructions with expected outcomes
|
|
- **Visual** - Screenshots or diagrams where helpful
|
|
- **Current** - Matches exactly how the system is implemented
|
|
|
|
---
|
|
|
|
### Modules to Document
|
|
|
|
| Module | Status | Documentation Needed |
|
|
|--------|--------|---------------------|
|
|
| **Dashboard** | Active | Overview, metrics explanation, navigation |
|
|
| **Add Keywords** | Active | How to browse, filter, select, add keywords |
|
|
| **Content Settings** | Active | Content Generation, Publishing, Image Settings tabs |
|
|
| **Sites** | Active | Site creation, WordPress integration, site management |
|
|
| **Planner - Keywords** | Active | Adding, managing, clustering keywords |
|
|
| **Planner - Clusters** | Active | Understanding clusters, generating ideas |
|
|
| **Planner - Ideas** | Active | Managing ideas, queueing to writer |
|
|
| **Writer - Queue** | Active | Task management, content generation |
|
|
| **Writer - Drafts** | Active | Reviewing drafts, status management |
|
|
| **Writer - Images** | Active | Image generation, management |
|
|
| **Writer - Review** | Active | Review process, approval workflow |
|
|
| **Writer - Published** | Active | Published content, WordPress sync |
|
|
| **Automation** | Active | Pipeline setup, scheduling, monitoring |
|
|
| **Account Settings** | Active | Account, Profile, Team management |
|
|
| **Plans & Billing** | Active | Plans, upgrades, payment, invoices |
|
|
| **Usage** | Active | Understanding limits, credit usage, history |
|
|
| Linker | ❌ Not Active | Skip - not documenting |
|
|
| Optimizer | ❌ Not Active | Skip - not documenting |
|
|
| Sites/Site Builder | ❌ Not Active | Skip - legacy feature removed |
|
|
| Thinker | Admin Only | Skip - not user-facing |
|
|
|
|
---
|
|
|
|
### Documentation Structure
|
|
|
|
For each module, document:
|
|
|
|
```
|
|
## [Module Name]
|
|
|
|
### Overview
|
|
Brief description of what this module does and its purpose in the workflow.
|
|
|
|
### How to Access
|
|
- Navigation path to reach this module
|
|
- Direct URL
|
|
|
|
### Step-by-Step Guide
|
|
|
|
#### [Task 1 Name]
|
|
1. Step one with specific instruction
|
|
2. Step two with expected result
|
|
3. Step three...
|
|
|
|
#### [Task 2 Name]
|
|
1. Step one...
|
|
2. Step two...
|
|
|
|
### Key Features
|
|
- Feature 1: What it does
|
|
- Feature 2: What it does
|
|
|
|
### Tips & Best Practices
|
|
- Tip 1
|
|
- Tip 2
|
|
|
|
### Common Questions
|
|
Q: Question?
|
|
A: Answer
|
|
|
|
### Troubleshooting
|
|
- Problem: X
|
|
Solution: Y
|
|
```
|
|
|
|
---
|
|
|
|
### Detailed Documentation Outlines
|
|
|
|
#### Dashboard Documentation
|
|
|
|
```
|
|
## Dashboard
|
|
|
|
### Overview
|
|
Your command center showing workflow progress, key metrics, and quick actions.
|
|
|
|
### Metrics Explained
|
|
- Keywords: Total keywords in your workflow
|
|
- Articles: Content pieces created
|
|
- Images: Images generated
|
|
- Completion %: Overall workflow progress
|
|
|
|
### Workflow Progress
|
|
Visual pipeline showing: Sites → Keywords → Clusters → Ideas → Content → Published
|
|
|
|
### Quick Actions
|
|
- [Action 1]: What it does, when to use
|
|
- [Action 2]: What it does, when to use
|
|
|
|
### Setup Checklist
|
|
Understanding the setup completion indicator...
|
|
```
|
|
|
|
#### Add Keywords Documentation
|
|
|
|
```
|
|
## Add Keywords
|
|
|
|
### Overview
|
|
Browse and add keywords from our curated database to your content workflow.
|
|
|
|
### Prerequisites
|
|
- Active site with industry and sector selected
|
|
|
|
### Step-by-Step: Adding Keywords
|
|
|
|
1. Navigate to SETUP → Add Keywords
|
|
2. Browse available keywords filtered by your site's industry/sector
|
|
3. Use filters to narrow results:
|
|
- Search: Find specific keywords
|
|
- Country: Filter by target country
|
|
- Difficulty: Filter by SEO difficulty
|
|
4. Select keywords by clicking checkboxes
|
|
5. Click "Add to Workflow" button
|
|
6. Keywords are now in your Planner
|
|
|
|
### After Adding Keywords
|
|
Click "Next: Plan Your Content →" to proceed to the Planner module.
|
|
|
|
### Tips
|
|
- Start with 10-20 keywords to test your workflow
|
|
- Mix high and low difficulty keywords
|
|
- Focus on your core topics first
|
|
```
|
|
|
|
#### Planner Documentation
|
|
|
|
```
|
|
## Planner
|
|
|
|
### Overview
|
|
Organize keywords into topic clusters and generate content ideas.
|
|
|
|
### The Planner Flow
|
|
Keywords → Clusters → Ideas → Writer Queue
|
|
|
|
---
|
|
|
|
### Keywords Tab
|
|
|
|
#### Adding Keywords Manually
|
|
1. Click "Add Keyword" button
|
|
2. Enter keyword text
|
|
3. Set initial status
|
|
4. Save
|
|
|
|
#### Clustering Keywords
|
|
1. Select keywords to cluster (checkboxes)
|
|
2. Click "Auto-Cluster" button
|
|
3. AI analyzes and groups related keywords
|
|
4. Review created clusters in Clusters tab
|
|
|
|
---
|
|
|
|
### Clusters Tab
|
|
|
|
#### Understanding Clusters
|
|
Clusters group related keywords by topic for focused content creation.
|
|
|
|
#### Generating Ideas from Clusters
|
|
1. Select cluster(s) to generate ideas for
|
|
2. Click "Generate Ideas" button
|
|
3. AI creates content ideas based on cluster keywords
|
|
4. Review ideas in Ideas tab
|
|
|
|
#### Cluster Progress
|
|
- Badge shows "X ideas" for clusters with generated ideas
|
|
- "No ideas yet" indicates pending clusters
|
|
|
|
---
|
|
|
|
### Ideas Tab
|
|
|
|
#### Reviewing Ideas
|
|
Each idea shows: title, target keyword, cluster source
|
|
|
|
#### Sending Ideas to Writer
|
|
1. Select ideas to write (checkboxes)
|
|
2. Click "Queue to Writer" button
|
|
3. Ideas become tasks in Writer Queue
|
|
```
|
|
|
|
#### Writer Documentation
|
|
|
|
```
|
|
## Writer
|
|
|
|
### Overview
|
|
Generate, review, and publish AI-created content.
|
|
|
|
### The Writer Flow
|
|
Queue → Drafts → Review → Published
|
|
|
|
---
|
|
|
|
### Queue Tab (Tasks)
|
|
|
|
#### Understanding Tasks
|
|
Tasks are content pieces waiting to be generated.
|
|
|
|
#### Generating Content
|
|
1. Find task in queue
|
|
2. Click "Generate Content" action
|
|
3. AI writes the article
|
|
4. Content moves to Drafts
|
|
|
|
---
|
|
|
|
### Drafts Tab
|
|
|
|
#### Reviewing Drafts
|
|
1. Click on draft to view full content
|
|
2. Review AI-generated article
|
|
3. Check content quality and accuracy
|
|
|
|
#### Moving to Review
|
|
1. Select draft(s)
|
|
2. Change status to "Review"
|
|
3. Content moves to Review tab
|
|
|
|
---
|
|
|
|
### Images Tab
|
|
|
|
#### Generating Images
|
|
1. Select content needing images
|
|
2. Click "Generate Images"
|
|
3. AI creates images based on content
|
|
4. Images attach to content
|
|
|
|
---
|
|
|
|
### Review Tab
|
|
|
|
#### Final Review Process
|
|
1. Review content and images together
|
|
2. Make any final adjustments
|
|
3. Approve for publishing
|
|
|
|
#### Publishing to WordPress
|
|
1. Select reviewed content
|
|
2. Click "Publish" button
|
|
3. Content syncs to WordPress
|
|
4. Moves to Published tab
|
|
|
|
---
|
|
|
|
### Published Tab
|
|
|
|
#### Viewing Published Content
|
|
- See all published articles
|
|
- WordPress sync status
|
|
- Publication dates
|
|
```
|
|
|
|
#### Automation Documentation
|
|
|
|
```
|
|
## Automation
|
|
|
|
### Overview
|
|
Automate your entire content pipeline from keywords to published articles.
|
|
|
|
### Pipeline Stages
|
|
1. Keywords → Clustering
|
|
2. Clusters → Idea Generation
|
|
3. Ideas → Task Creation
|
|
4. Tasks → Content Generation
|
|
5. Content → Image Prompt Extraction
|
|
6. Prompts → Image Generation
|
|
7. Review Gate
|
|
|
|
---
|
|
|
|
### Setting Up Automation
|
|
|
|
#### Configure Schedule
|
|
1. Set frequency (daily, weekly, etc.)
|
|
2. Set preferred run time
|
|
3. Enable/disable automation
|
|
|
|
#### Stage Controls
|
|
Enable or disable individual stages as needed.
|
|
|
|
#### Batch Size
|
|
Set how many items process per run.
|
|
|
|
---
|
|
|
|
### Running Automation
|
|
|
|
#### Manual Run
|
|
Click "Run Now" to start pipeline immediately.
|
|
|
|
#### Monitoring Progress
|
|
- Real-time progress display
|
|
- Stage-by-stage status
|
|
- Activity log
|
|
|
|
#### Handling Errors
|
|
- Failed items shown in log
|
|
- Click "Retry" to reprocess failed items
|
|
|
|
---
|
|
|
|
### Best Practices
|
|
- Start with small batch sizes
|
|
- Monitor first few runs closely
|
|
- Review automation output regularly
|
|
```
|
|
|
|
#### Account Settings Documentation
|
|
|
|
```
|
|
## Account Settings
|
|
|
|
### Overview
|
|
Manage your account, profile, and team.
|
|
|
|
---
|
|
|
|
### Account Tab
|
|
- Organization name
|
|
- Billing email
|
|
- Billing address
|
|
- Tax ID/VAT number
|
|
|
|
---
|
|
|
|
### Profile Tab
|
|
- Personal information (name, email, phone)
|
|
- Timezone and language preferences
|
|
- Notification settings
|
|
- Security settings (password, 2FA)
|
|
|
|
#### Changing Password
|
|
1. Go to Profile tab
|
|
2. Click "Change Password"
|
|
3. Enter current password
|
|
4. Enter and confirm new password
|
|
5. Save changes
|
|
|
|
---
|
|
|
|
### Team Tab
|
|
|
|
#### Inviting Team Members
|
|
1. Click "Invite Member"
|
|
2. Enter email address
|
|
3. Select role (Admin or Member)
|
|
4. Send invitation
|
|
|
|
#### Managing Members
|
|
- View all team members
|
|
- Change member roles
|
|
- Remove members
|
|
|
|
#### Team Limits
|
|
Your plan allows X team members. Currently using Y.
|
|
```
|
|
|
|
#### Plans & Billing Documentation
|
|
|
|
```
|
|
## Plans & Billing
|
|
|
|
### Overview
|
|
Manage your subscription, view invoices, and track payments.
|
|
|
|
---
|
|
|
|
### Current Plan Tab
|
|
- Plan name and features
|
|
- Credit balance
|
|
- Renewal date
|
|
- Usage summary
|
|
|
|
---
|
|
|
|
### Upgrade Plan Tab
|
|
|
|
#### Changing Plans
|
|
1. Review available plans
|
|
2. Compare features
|
|
3. Click "Upgrade" on desired plan
|
|
4. Review proration (credit for remaining time)
|
|
5. Confirm change
|
|
|
|
#### Cancelling Plan
|
|
1. Click "Cancel Plan"
|
|
2. Review what you'll lose
|
|
3. Confirm cancellation
|
|
|
|
---
|
|
|
|
### History Tab
|
|
- Invoice history with PDF download
|
|
- Payment records
|
|
- Payment method management
|
|
```
|
|
|
|
#### Usage Documentation
|
|
|
|
```
|
|
## Usage
|
|
|
|
### Overview
|
|
Track your credit usage, limits, and activity.
|
|
|
|
---
|
|
|
|
### Your Limits & Usage Tab
|
|
|
|
#### Understanding Limits
|
|
- **Hard Limits:** Maximum allowed (sites, users, keywords)
|
|
- **Monthly Limits:** Reset each billing cycle
|
|
|
|
#### Credit Balance
|
|
- Credits remaining
|
|
- Credits used this month
|
|
- Monthly allocation
|
|
|
|
---
|
|
|
|
### Credit History Tab
|
|
Transaction log showing all credit activity:
|
|
- Credit additions (plan, purchases)
|
|
- Credit usage (content, images, etc.)
|
|
|
|
---
|
|
|
|
### API Activity Tab
|
|
- Total API calls
|
|
- Success rate
|
|
- Activity by endpoint
|
|
|
|
---
|
|
|
|
### Usage Alerts
|
|
Automatic alerts at 80%, 90%, and 100% of limits.
|
|
```
|
|
|
|
---
|
|
|
|
## 5.3 FAQ Updates
|
|
|
|
### Current FAQ Topics (~20 questions)
|
|
Review and update existing FAQ to ensure accuracy.
|
|
|
|
### Additional FAQ Topics Needed
|
|
|
|
| Topic | Questions to Add |
|
|
|-------|------------------|
|
|
| Credits | How credits work, what uses credits, credit costs |
|
|
| Automation | How to set up, troubleshooting, best practices |
|
|
| WordPress | Integration setup, sync issues, troubleshooting |
|
|
| Content | Generation tips, quality settings, editing |
|
|
| Images | Generation options, formats, sizes |
|
|
| Billing | Payment methods, invoices, plan changes |
|
|
|
|
---
|
|
|
|
## Summary
|
|
|
|
### Total Issues
|
|
|
|
| Category | Critical | High | Medium | Low | Total |
|
|
|----------|----------|------|--------|-----|-------|
|
|
| Support/Links | 4 | 0 | 0 | 0 | 4 |
|
|
| Pages to Delete | 0 | 1 | 0 | 0 | 1 |
|
|
| Features | 0 | 0 | 2 | 1 | 3 |
|
|
| Documentation | 0 | 1 | 0 | 0 | 1 |
|
|
| **TOTAL** | **4** | **2** | **2** | **1** | **9** |
|
|
|
|
---
|
|
|
|
### Critical Items (Must Fix)
|
|
|
|
1. Fix Support dropdown link (currently 404)
|
|
2. Implement Contact Support button (mailto: or support URL)
|
|
3. Implement Feature Request button (mailto: or feedback URL)
|
|
4. Configure working support channel
|
|
|
|
---
|
|
|
|
### High Priority Items
|
|
|
|
1. Delete placeholder pages (`/help/docs`, `/help/system-testing`, `/help/function-testing`)
|
|
2. Create comprehensive step-by-step documentation for all active modules
|
|
|
|
---
|
|
|
|
### Files to Delete
|
|
|
|
| File | Reason |
|
|
|------|--------|
|
|
| `pages/Help/Documentation.tsx` | Empty placeholder |
|
|
| `pages/Help/SystemTesting.tsx` | Empty placeholder |
|
|
| `pages/Help/FunctionTesting.tsx` | Empty placeholder |
|
|
|
|
---
|
|
|
|
### Files to Modify
|
|
|
|
| File | Changes |
|
|
|------|---------|
|
|
| `pages/Help/HelpCenter.tsx` | Fix support link, implement button handlers, add comprehensive documentation, update FAQ |
|
|
| Router/App.tsx | Remove routes for deleted help pages |
|
|
|
|
---
|
|
|
|
### Documentation Modules (Do NOT Document)
|
|
|
|
| Module | Reason |
|
|
|--------|--------|
|
|
| Linker | Not active |
|
|
| Optimizer | Not active |
|
|
| Sites/Site Builder | Legacy feature removed |
|
|
| Thinker | Admin only - not user-facing |
|
|
|
|
---
|
|
|
|
### Documentation Deliverables
|
|
|
|
Create detailed step-by-step documentation for:
|
|
|
|
1. ✅ Dashboard
|
|
2. ✅ Add Keywords
|
|
3. ✅ Content Settings
|
|
4. ✅ Sites (WordPress integration focus, not site builder)
|
|
5. ✅ Planner - Keywords
|
|
6. ✅ Planner - Clusters
|
|
7. ✅ Planner - Ideas
|
|
8. ✅ Writer - Queue/Tasks
|
|
9. ✅ Writer - Drafts
|
|
10. ✅ Writer - Images
|
|
11. ✅ Writer - Review
|
|
12. ✅ Writer - Published
|
|
13. ✅ Automation
|
|
14. ✅ Account Settings
|
|
15. ✅ Plans & Billing
|
|
16. ✅ Usage
|
|
|
|
---
|