This commit is contained in:
alorig
2025-12-12 16:00:03 +05:00
parent b2e8732a82
commit 12956ec64a
3 changed files with 0 additions and 556 deletions

View File

@@ -1,556 +0,0 @@
---
# **APP LAUNCH PLAN: ITEMS 1 to 3**
# **Item 1: Status Modules for AI Planner and Writer**
### **Objective**
Ensure Planner and Writer status tracking is consistent, accurate, and fully functional across backend and frontend.
### **Work Scope**
#### **A. Backend**
* Standardize status states for:
* Planner tasks
* Writer tasks
* Queue processing
* AI function progress
* Create unified status enums and error codes.
* Ensure all AI jobs push accurate progress updates during:
* Keyword extraction
* Clustering
* Idea generation
* Content generation
* Image generation
* Ensure all status updates propagate through WebSockets or async polling.
* Log transitions for debugging.
#### **B. Frontend**
* Display accurate status for:
* Each task
* Each queue item
* Each stage of execution
* Ensure Planner and Writer modals show:
* Correct live progress
* Correct messaging
* Correct completion and failure notices
* Refactor old status code to match backend changes.
#### **C. QA**
* Test all workflows manually on:
* Keywords
* Clusters
* Ideas
* Content
* Automation wizard
* Test edge cases:
* Stuck tasks
* Failed tasks
* Incorrect counts
* Race conditions
* Validate real-time UI updates.
---
# **Item 2: Credits, Billing, Pricing Logic, and Usage Limits**
### **Objective**
Define credit costs per AI function and define plan limits for counts and usage.
### **Work Scope**
#### **A. Define Credit Cost per AI Function**
For each AI operation, decide exact credit cost:
* Keyword extraction
* Clustering
* SAG mapping
* Idea generation
* Content generation (per word length)
* Image generation
* Any additional operations
This defines package pricing and resource consumption.
#### **B. Define Plan-Based Usage Limits**
Define limits that each plan can have:
* Maximum keywords saved
* Maximum clusters
* Maximum ideas
* Maximum content pieces
* Maximum images
* Max tasks queued at a time
* Limits for daily or monthly usage caps
* Per-account or per-user limits
These limits sit **on top of credit allocation**, or credit alone may cap output. Decision required.
#### **C. Backend Implementation**
* Add limit checks in API for create actions.
* Add counters for monthly/daily usage.
* Add logic to block or warn when limits reached.
* Integrate credit deduction rules per function.
#### **D. Frontend Implementation**
* Show plan limits clearly.
* Show remaining credits and remaining records.
* Show warnings when nearing limits.
* Unify progress counters in dashboards.
#### **E. Pricing Plan Optimization**
* After defining credit values and limits:
* Create Starter, Growth, Pro, and Enterprise plans.
* Set competitive credit allocations.
* Set record-based limits and overage policies.
* Ensure predictable cost for users and profitability for platform.
---
# **Item 3: Prompt Improvement and Model Optimization**
### **Objective**
Fully redesign AI prompts for extreme accuracy, consistent output, faster processing, and correct word count. Improve content quality, clustering quality, and image prompts.
### **Work Scope**
#### **A. SAG Clustering Prompt**
Handled separately later but included as part of item 3.
Goal:
* Convert IGNY8 semantic architecture into an AI-usable compact prompt.
* Include examples.
* Produce consistent clustering across all modules.
(This will be done in next phase.)
---
#### **B. Idea Generation Prompt (Improve Existing Prompt)**
Improvements needed:
* Increase semantic alignment with cluster intent.
* Produce stronger, more realistic editorial ideas.
* Improve JSON formatting reliability.
* Better keyword mapping.
* Ensure structure variation and non-repetitive logic.
* Produce cluster hub + proper supporting ideas with strict editorial rules.
Output:
A refined prompt for idea generation with optimized structure, clarity, and output consistency.
---
#### **C. Content Generation Prompt (Improve Existing Prompt)**
Improvements needed:
1. **Precise word-count adaptation**
* 500, 1000, 1500 words
* Automatic proportional scaling
2. **Better editorial quality**
* Richer depth
* More variation in style and examples
* No generic flavor
3. **Smarter structure control**
* Paragraphs first
* Then list/table
* Never start with list
* Proper subsection placement
4. **Strict SEO rules**
* Primary keyword in title, intro, and two H2s
* Natural secondary keywords
5. **HTML consistency**
* Clean tags
* No broken JSON strings
6. **Better image prompts**
* Clear
* Topic relevant
* Frontend-friendly
Output:
A set of optimized content prompts for 500, 1000, 1500 versions.
---
# **Summary of Deliverables for Items 13**
### **Item 1 Deliverables**
* Unified backend status engine
* Clean frontend progress modals
* Error-proof workflow states
* Automation wizard corrections
### **Item 2 Deliverables**
* Full credit cost table per function
* Pricing plan limits and counters
* Backend logic for limit enforcement
* Frontend display of usage and credit consumption
### **Item 3 Deliverables**
* Rewritten idea-generation prompt
* Rewritten content-generation prompt (3 lengths)
* Improved image prompt format
* Separate SAG clustering prompt (later)
---
# 4. Page Flow and Workflow UX Improvements
Improve the overall navigation, page structure, workflow clarity, and helper systems across all main user-facing areas.
## 4.1 Improve Page Flows Across Main Menu Groups
### Groups to cover
* Setup
* Workflow
* Account
* Settings
### Required Enhancements
| Area | Improvement |
| -------------------- | ------------------------------------------------------------------------------------ |
| Navigation hierarchy | Standardize all menu groups and subpages with consistent UX patterns. |
| Linear workflows | Ensure planner and writer flows follow a clear step-by-step progression. |
| Breadcrumbs | Add contextual breadcrumbs for deeper sections. |
| Page orientation | Each page requires a header with title, short description, and quick action buttons. |
| Cross-navigation | Add "Back to previous step", "Continue", and "View progress" controls. |
---
## 4.2 Workflow UX Improvements
### Planner and Writer workflows need:
* Step banners
* Clear state indicators
* Autosave indicators
* Better use of helper components
### Helper Elements Required
| Component | Purpose |
| -------------------- | ------------------------------------------------------------------ |
| Helper notifications | Display small contextual guidance when entering a new screen. |
| Tooltips | For icons, complex actions, and configuration options. |
| Inline guidance | Small text under fields explaining purpose or required formatting. |
| Step banners | Persistent “Step X of Y” headers guiding the user. |
---
## 4.3 Notification System
### Requirements
* Event-driven notifications for task progress, completion, failure, errors, and actions required.
* Unified notification dropdown accessible via bell icon in the header.
### Notification Types
| Type | Examples |
| --------------- | ------------------------------------------------------- |
| Progress | Planner or writer job started, queued, processing. |
| Success | Content generated, workflow completed, export success. |
| Failure | API errors, workflow failure, validation issues. |
| Action required | Missing settings, incomplete fields, failed publishing. |
### Dropdown Features
* Chronological list
* Read/unread states
* Links to relevant pages or tasks
* Icon-based status indicators (info, success, warning, danger)
---
## 4.4 Global and Page-level Metrics
### Bottom Metrics Panel (per workflow page)
* Move detailed metrics to the bottom of Planner and Writer workflows.
* Collapsible panel.
* Shows counts, progress, keyword metrics, SEO density, etc.
### Header Metrics (global)
Improved header-level metrics visible everywhere:
* Tasks in progress
* Completed tasks
* Failed tasks
* Credits remaining
* Usage summary
* Notification count
---
## 4.5 Tenant-level Settings Reorganization
### Problem
Settings are scattered and inconsistent.
### Solution
Create a centralized **Tenant Settings Hub** (superuser excluded).
### New Structure
| Category | Subpages |
| ------------------- | ----------------------------------------------------- |
| General | Basic account settings, display options. |
| Publishing | WordPress connection, publishing defaults, SEO rules. |
| Pagination | Control pagination for listings, workflows, results. |
| Branding | Logo, colors, styling preferences. |
| Workflow Defaults | Planner, writer, auto settings, task behaviors. |
| Integrations | API keys, external platforms, plugins. |
| Notifications | Type preferences, email alerts, push alerts. |
| Account and Billing | Plan, credits, invoices, team access. |
---
# 5. WordPress Content Template Improvements and Redesign
## 5.1 Image Reuse Logic
Automatically reuse available images based on count.
| Available Images | Behavior |
| ---------------- | ------------------------------------------------------------------ |
| 1 | Reuse multiple times across intro, middle, and final sections. |
| 2 | Alternate image placement across sections. |
| 3 | Use each twice for balanced distribution. |
| More than 3 | Use each once until exhausted, then reuse based on article length. |
---
## 5.2 Placement Rules
Images must appear at predictable, meaningful points.
| Placement | Purpose |
| ------------------------ | ----------------------------------- |
| After introduction | Establish visual tone. |
| Before major H2 sections | Break reading monotony. |
| Mid-article | Reset attention, add visual pacing. |
| Before conclusion | Support final argument or CTA. |
---
## 5.3 Template Versions by Article Length
### A. 500-word Template
* Intro (1 paragraph)
* H2 Section 1 (1 paragraph)
* H2 Section 2 (12 paragraphs)
* Conclusion (1 paragraph)
* Images: 2 to 3 placements
### B. 1000-word Template
* Intro (2 paragraphs)
* H2 Section 1 (2 paragraphs)
* H2 Section 2 (2 paragraphs)
* H2 Section 3 (2 paragraphs)
* Conclusion (2 paragraphs)
* Images: 3 to 5 placements
### C. 1500-word Template
* Intro (23 paragraphs)
* H2 Section 1 (3 paragraphs)
* H2 Section 2 (3 paragraphs)
* H2 Section 3 (3 paragraphs)
* Optional additional H2 or H3 subsections
* Conclusion with CTA
* Images: 4 to 7 placements
---
## 5.4 Cluster Hub Landing Page Template
This single template is reused for:
* Cluster hubs
* Category pages
* Tag archive pages
### Core Structure
| Section | Description |
| ---------------------- | ------------------------------------------------- |
| Hero section | Term title, description, and optional hero image. |
| Featured visual | Illustration or banner for cluster identity. |
| Overview block | Short intro text about the topic group. |
| Subcluster cards | If hierarchical categories exist. |
| Latest articles list | Auto-populated. |
| Popular articles block | Based on views or tagging. |
| CTA block | Newsletter or lead magnet. |
| Footer navigation | Internal linking anchors. |
### Conditional Variants
| Term Type | Variation |
| ----------- | -------------------------------------- |
| Category | Shows category tree and subcategories. |
| Tag | Shows related tag cloud. |
| Cluster Hub | Includes deeper cluster overview map. |
---
# 6. Frontend Marketing Site
## 6.1 Update Marketing Site Content
### Pages to Update
| Page | Required Work |
| -------------- | ------------------------------------------------------------------------ |
| Home | Rewrite hero, features, workflows, CTAs, add visuals. |
| Features | List key modules: planner, writer, metrics, notifications, settings hub. |
| Product pages | Dedicated pages for each workflow module. |
| Use-case pages | For agencies, e-commerce, content teams. |
| About | Mission, philosophy, architecture reasoning. |
| Contact | Updated contact and support flow. |
---
## 6.2 Update Pricing Page and Plans
### Required Upgrades
| Area | Details |
| ------------------- | ------------------------------------------------------- |
| Plan definitions | Clearly define Free, Starter, Growth, Enterprise tiers. |
| Usage-based pricing | Explain credit system and workflow limits. |
| Add-ons | Extra users, domains, integrations. |
| Comparison tables | Feature-by-feature breakdown. |
| Billing cycles | Monthly and annual toggles. |
| Global currencies | USD baseline, PK optional. |
| FAQs under pricing | Immediate resolution for common objections. |
---
# 7. Documentation
## 7.1 In-app Documentation
### Areas to update
| Section | Required Documentation |
| ------------------ | ------------------------------------------------- |
| Planner workflow | Step-by-step guides, tooltips, screenshots. |
| Writer workflow | Drafting, editing, optimization, publishing. |
| Tenant settings | Publishing, pagination, defaults, integrations. |
| Metrics | Definitions, data refresh rules, interpretation. |
| Notifications | Event types, triggers, statuses, troubleshooting. |
| Account management | Team roles, permissions, billing, usage. |
### Placement
* Floating help icon
* Embedded guides per workflow
* Onboarding tutorials
---
## 7.2 Marketing Site Documentation
### Includes
| Area | Content Needed |
| ------------------- | -------------------------------------- |
| API documentation | Endpoints, auth, requests, responses. |
| Integration guides | WordPress setup, API keys, automation. |
| Workflow guides | Planner-to-writer SEO flow. |
| AI usage | Credit consumption and behavior specs. |
| Notification events | JSON payloads, event types, callbacks. |
| Data privacy | Storage, security, backups. |
---
## 7.3 FAQ Updates
### Categories
* General
* Pricing
* Content generation
* Integrations
* Settings
* Technical troubleshooting
* Data handling
### Structure
* Accordion layout
* Search bar
* Support CTA
---
Known bugs and issues
1. AI functions
Manual run on pages
For pages: Keywords, Cluster, and Tasks, for clustering, idea generation, content generation:
The texts shown in manual AI function run for Planner and Writer progress modals:
Text is not accurate.
Needs to be fixed for all different modals based on the specific function running.
Process to fix:
Ask AI agent to build a table of current texts.
Then optimize these texts with:
Better wording.
Dynamic variables.
Automation (Manual Run for automation wizard on automation page)
Wrong queue items.
Missing queue items.
Progress bar does not progress properly.
Total in queue and processed counts are buggy for many stages.
Stage cards:
Realtime metrics not optimized.
Should be more robust and more user friendly.
user sometimes log out atumatically ,