myaidev-method 0.2.23 → 0.2.24-2

package/USER_GUIDE.md

@@ -7,6 +7,7 @@ This guide covers everything you need to know about using, customizing, and exte
 ## 📋 Table of Contents
 
 - [Quick Start](#quick-start)
+- [Plugin Architecture & Skills](#-plugin-architecture--skills)
 - [System Configuration](#-system-configuration)
 - [Updating MyAIDev Method](#-updating-myaidev-method)
 - [Understanding the Structure](#understanding-the-structure)
@@ -120,6 +121,119 @@ Use the interactive configuration command to set up your environment—no manual
 /myai-configure agents --list
 ```
 
+## 🔌 Plugin Architecture & Skills
+
+**New in v0.2.25!** MyAIDev Method now supports a modern plugin-based architecture with discoverable skills, cross-platform compatibility, and marketplace distribution.
+
+### What's New
+
+- **Skills-Based Architecture**: Capabilities are now defined as discoverable SKILL.md files
+- **Plugin Marketplace**: Install packs from the MyAIDev marketplace
+- **Cross-Platform Support**: Works with Claude Code, Gemini CLI, and Codex CLI
+- **Dual Command Naming**: Both legacy (`/myai-*`) and namespaced (`/myaidev-method:*`) commands work
+- **Installation Detection**: CLI commands to detect and upgrade installations
+
+### Installation Options
+
+#### NPX Installation (Recommended)
+
+The traditional method continues to work:
+
+```bash
+# Full installation
+npx myaidev-method@latest init --claude
+
+# Workflow-specific
+npx myaidev-method@latest content --claude
+npx myaidev-method@latest dev --claude
+npx myaidev-method@latest security --claude
+```
+
+#### Plugin Installation (Future)
+
+When Claude Code plugin marketplace becomes available:
+
+```bash
+# Add marketplace
+/plugin marketplace add myaione/myaidev-method
+
+# Install full or specific packs
+/plugin install myaidev-method@myaidev-marketplace
+/plugin install myaidev-content@myaidev-marketplace
+```
+
+### Skills Overview
+
+Skills are organized into packs for modular installation:
+
+| Pack | Skills | Use Case |
+|------|--------|----------|
+| **content** | content-writer, content-verifier, visual-generator, wordpress-publisher | Content creation and publishing |
+| **development** | sparc-architect, sparc-coder, sparc-tester, sparc-reviewer, sparc-documenter | SPARC methodology software development |
+| **security** | security-tester, security-auditor | Penetration testing and auditing |
+| **infrastructure** | coolify-deployer, openstack-manager | Deployment and cloud management |
+
+### SKILL.md Format
+
+Each skill is defined with YAML frontmatter:
+
+```markdown
+---
+name: content-writer
+description: Professional SEO-optimized content creation
+argument-hint: [topic] [--word-count=1500] [--tone=professional]
+allowed-tools: [Read, Write, Edit, WebSearch, WebFetch, Task]
+user-invocable: true
+category: content
+version: 1.0.0
+platforms: [claude-code, gemini-cli, codex-cli]
+---
+
+# Content Writer Skill
+
+[Skill instructions and capabilities...]
+```
+
+### Command Aliasing
+
+Both naming conventions work:
+
+| Legacy | Namespaced | Function |
+|--------|------------|----------|
+| `/myai-content-writer` | `/myaidev-method:content-writer` | Create content |
+| `/myai-configure` | `/myaidev-method:configure` | Configuration |
+| `/myai-wordpress-publish` | `/myaidev-method:wordpress-publish` | WordPress publishing |
+| `/myai-generate-visual` | `/myaidev-method:generate-visual` | Visual generation |
+| `/myai-openstack` | `/myaidev-method:openstack` | OpenStack management |
+
+### Installation Management Commands
+
+```bash
+# Detect current installation type
+npx myaidev-method detect
+
+# Show plugin information
+npx myaidev-method plugin-info
+
+# Upgrade from legacy to plugin architecture
+npx myaidev-method upgrade
+```
+
+### Backward Compatibility
+
+All existing functionality is preserved:
+
+- ✅ `npx myaidev-method init --claude` works exactly as before
+- ✅ All `/myai-*` commands work with same names and behavior
+- ✅ All agents in `.claude/agents/` work as before
+- ✅ Existing user installations are not affected
+
+### Resources
+
+- **Plugin Documentation**: [PLUGIN_ARCHITECTURE.md](PLUGIN_ARCHITECTURE.md)
+- **Marketplace**: https://dev.myai1.ai/plugins/myaidev-method
+- **GitHub**: https://github.com/myaione/myaidev-method
+
 ## ⚙️ System Configuration
 
 MyAIDev Method uses the `/myai-configure` command for interactive setup—**no manual `.env` file editing required**. This is the recommended way to configure all integrations.
@@ -503,15 +617,34 @@ for file in content/*.md; do
 done
 ```
 
-#### Publishing Configuration
+#### Content Pipeline Setup
+
+Set up your content creation pipeline with these configuration steps:
 
-Set up your publishing credentials once using the interactive configuration:
+**Step 1: Configure Brand Voice & Content Rules (Recommended First)**
+
+```bash
+# Interactive wizard for brand voice, tone, SEO guidelines, and formatting
+/myai-content-rules-setup
+```
+
+This creates a `content-rules.md` file that customizes all AI-generated content to match your brand. The wizard guides you through:
+- Brand identity (company name, values, mission)
+- Voice & tone (personality, communication style)
+- Writing style (formality, sentence structure)
+- SEO guidelines (keyword density, meta requirements)
+- Formatting preferences (lists, headers, code blocks)
+- Content boundaries (topics to emphasize or avoid)
+
+> **Tip**: Set up content rules before creating your first content. This ensures consistent brand voice from day one.
+
+**Step 2: Configure Publishing Platforms**
 
 ```bash
 # Configure WordPress (recommended - no manual .env editing)
 /myai-configure wordpress
 
-# Configure default content settings
+# Configure visual generation APIs (optional)
 /myai-configure defaults
 ```
 
@@ -533,24 +666,318 @@ PAYLOADCMS_PASSWORD=your-password
 
 #### Content Creator Workflow Example
 
-Complete workflow from research to publication:
+Complete workflow from setup to publication:
 
 ```bash
-# 1. Research and create content
+# 1. First-time setup: Configure brand voice (creates content-rules.md)
+/myai-content-rules-setup
+
+# 2. Configure publishing destination
+/myai-configure wordpress
+
+# 3. Create content (automatically uses your content-rules.md)
 /myai-content-writer "Ultimate guide to TypeScript generics with practical examples"
 
-# 2. Review generated markdown file (typescript-generics-guide.md)
+# 4. Review generated markdown file (typescript-generics-guide.md)
+#    Content will match your brand voice, SEO guidelines, and formatting preferences
 
-# 3. Publish to WordPress as draft for review
+# 5. Publish to WordPress as draft for review
 /myai-wordpress-publish "typescript-generics-guide.md" --status draft
 
-# 4. Review on WordPress, make edits if needed
+# 6. Review on WordPress, make edits if needed
 
-# 5. Publish to additional platforms
+# 7. Publish to additional platforms
 /myai-payloadcms-publish "typescript-generics-guide.md" --status published
 /myai-docusaurus-publish "typescript-generics-guide.md" --category advanced-topics
 ```
 
+> **Note**: Steps 1-2 are one-time setup. For subsequent content, start at step 3.
+
+#### Batch Content Coordination
+
+For publishing multiple pieces of content at once, use the Content Production Coordinator—a powerful orchestration system that coordinates content verification, quality analysis, and multi-platform publishing.
+
+```bash
+# Process all content in a queue directory
+/myai-coordinate-content ./content-queue/
+```
+
+**Setting Up a Content Queue:**
+
+1. Create a directory for your content queue:
+   ```bash
+   mkdir -p ./content-queue
+   ```
+
+2. Add content files using the required format:
+
+**Content Queue File Format** (e.g., `./content-queue/my-article.md`):
+
+```markdown
+---
+title: "Your Article Title"
+content_type: article
+target_platform: wordpress
+status: pending
+priority: normal
+references:
+  - "https://source1.com"
+  - "https://source2.com"
+goals:
+  - "Primary goal for this content"
+  - "Secondary goal"
+---
+
+## Proprietary Content
+
+[Your unique insights, original analysis, and value-add content here.
+This is the section that gets verified for uniqueness.]
+
+## Supporting Content
+
+[Additional context, examples, and supporting material]
+```
+
+**Required Fields:**
+| Field | Description |
+|-------|-------------|
+| `title` | Article title (used for publishing) |
+| **Proprietary Content section** | Your unique content to be verified |
+
+**Optional Fields:**
+| Field | Values | Default |
+|-------|--------|---------|
+| `content_type` | article, tutorial, guide, listicle | article |
+| `target_platform` | wordpress, payloadcms, static, docusaurus, mintlify, astro | wordpress |
+| `status` | pending, verified, published, failed | pending |
+| `priority` | high, normal, low | normal |
+| `references` | Array of source URLs | [] |
+| `goals` | Array of publishing goals | [] |
+| `publish_date` | ISO 8601 date for scheduled publishing | immediate |
+
+3. Run the coordinator:
+   ```bash
+   /myai-coordinate-content ./content-queue/
+   ```
+
+#### Coordinator Features
+
+**Core Operations:**
+```bash
+# Verify only, no publishing
+/myai-coordinate-content ./content-queue/ --dry-run
+
+# Skip confirmations (for automation)
+/myai-coordinate-content ./content-queue/ --force
+
+# Detailed progress output
+/myai-coordinate-content ./content-queue/ --verbose
+
+# Custom report directory
+/myai-coordinate-content ./content-queue/ --output-dir ./reports/
+
+# Higher concurrency for large batches
+/myai-coordinate-content ./content-queue/ --concurrency 5
+```
+
+**Multi-Platform Publishing:**
+```bash
+# Publish to PayloadCMS instead of WordPress
+/myai-coordinate-content ./content-queue/ --platform payloadcms
+
+# Generate static markdown files
+/myai-coordinate-content ./content-queue/ --platform static --output-dir ./published/
+
+# Publish to Docusaurus documentation site
+/myai-coordinate-content ./docs-queue/ --platform docusaurus
+```
+
+Each content item can override the default platform using the `target_platform` front matter field.
+
+**Content Rules Integration:**
+```bash
+# Use custom content rules file
+/myai-coordinate-content ./content-queue/ --content-rules ./brand/content-rules.md
+
+# Content rules are auto-detected from standard locations
+/myai-coordinate-content ./content-queue/  # Finds ./content-rules.md automatically
+```
+
+The coordinator automatically searches for `content-rules.md` in these locations:
+1. Explicit path via `--content-rules`
+2. `./content-rules.md` (current directory)
+3. `./.claude/content-rules.md`
+4. `./docs/content-rules.md`
+
+**CI/CD Integration with Webhooks:**
+```bash
+# Send notifications to CI/CD webhook
+/myai-coordinate-content ./content-queue/ --webhook-url https://ci.example.com/webhook
+
+# Notify on all events including each published item
+/myai-coordinate-content ./content-queue/ \
+  --webhook-url https://ci.example.com/webhook \
+  --webhook-events start,complete,error,published
+
+# Full CI/CD pipeline integration
+/myai-coordinate-content ./content-queue/ --force --webhook-url $CI_WEBHOOK_URL --analytics
+```
+
+**Available Webhook Events:**
+- `start` - When workflow begins
+- `complete` - When workflow finishes successfully
+- `error` - When errors occur
+- `published` - When each item is published
+
+**Queue Management:**
+```bash
+# Add new content to queue without processing
+/myai-coordinate-content ./new-articles/ --add-to-queue
+
+# View queue statistics
+/myai-coordinate-content --queue-stats
+
+# Process items from queue
+/myai-coordinate-content --queue .content-queue.json
+
+# Clear completed items from queue
+/myai-coordinate-content --clear-completed
+```
+
+**Analytics & Monitoring:**
+```bash
+# Enable detailed analytics (default)
+/myai-coordinate-content ./content-queue/ --analytics
+
+# Full production run with all options
+/myai-coordinate-content ./content-queue/ \
+  --verbose \
+  --output-dir ./reports/ \
+  --concurrency 3 \
+  --content-rules ./brand/content-rules.md \
+  --webhook-url https://ci.example.com/webhook \
+  --analytics
+```
+
+When analytics are enabled, generates `analytics-YYYY-MM-DD-HH-MM-SS.md` with:
+- Per-phase timing metrics
+- Success/failure rates
+- Average verification and publishing times
+- Content quality score trends
+- Error categorization
+
+#### Scheduling & Automation
+
+**Linux Crontab Integration:**
+
+```bash
+# Generate crontab entry with instructions
+/myai-coordinate-content --generate-crontab
+
+# Run in cron-safe mode (for crontab)
+/myai-coordinate-content ./content-queue/ --cron --force
+
+# With minimum 6-hour interval between runs
+/myai-coordinate-content ./content-queue/ --cron --min-interval 21600
+```
+
+**Example crontab entries:**
+```bash
+# Every 6 hours
+0 */6 * * * cd /path/to/project && npx myaidev-method coordinate-content ./content-queue --cron --force >> /var/log/content-coordinator.log 2>&1
+
+# Daily at 9 AM
+0 9 * * * cd /path/to/project && npx myaidev-method coordinate-content ./content-queue --cron --force >> /var/log/content-coordinator.log 2>&1
+
+# Weekdays at 9 AM and 5 PM
+0 9,17 * * 1-5 cd /path/to/project && npx myaidev-method coordinate-content ./content-queue --cron --force >> /var/log/content-coordinator.log 2>&1
+```
+
+**WordPress Post Scheduling:**
+
+Schedule posts for future publication using WordPress's native scheduling:
+
+```bash
+# Delay all posts by 24 hours
+/myai-coordinate-content ./content-queue/ --schedule-delay 24
+
+# Spread posts 6 hours apart
+/myai-coordinate-content ./content-queue/ --spread-interval 6
+
+# Combined: Start in 24 hours, then every 6 hours
+/myai-coordinate-content ./content-queue/ --schedule-delay 24 --spread-interval 6
+```
+
+You can also set specific publish dates in content front matter:
+```yaml
+---
+title: "My Article"
+publish_date: "2026-02-15T09:00:00Z"  # Schedule for specific date
+---
+```
+
+**Combined Automation (Cron + WordPress Scheduling):**
+```bash
+# Run via cron, but schedule posts for optimal times
+/myai-coordinate-content ./content-queue/ \
+  --cron \
+  --force \
+  --schedule-delay 24 \
+  --spread-interval 6 \
+  --webhook-url https://ci.example.com/content-published
+```
+
+#### Checkpoint/Resume
+
+The coordinator automatically saves progress to `.content-coordinator-state.json`. If interrupted:
+- Re-run the same command to resume from the last checkpoint
+- Use `--fresh` to start over and ignore saved state
+- Delete the state file manually to reset
+
+#### Output Reports
+
+The coordinator generates timestamped reports:
+
+**Ready for Publishing Report** (`ready-for-publishing-YYYY-MM-DD-HH-MM-SS.md`):
+```markdown
+# Content Ready for Publishing
+Generated: YYYY-MM-DD HH:MM:SS
+
+## Summary
+- Total Items: X
+- Total Word Count: ~Y,000 words
+- Average Redundancy Score: Low/Minimal
+
+## Items
+
+### 1. [Title]
+- **Redundancy Score**: Low
+- **Recommendation**: Proceed with publishing
+- **Word Count**: ~1,200 words
+- **Verifier Feedback**: [Brief feedback]
+- **References**: [List of references]
+- **Goals**: [Publishing goals]
+```
+
+**Needs Review Report** (`needs-review-YYYY-MM-DD-HH-MM-SS.md`):
+```markdown
+# Content Requiring Review
+Generated: YYYY-MM-DD HH:MM:SS
+
+## Summary
+- Total Items: X
+- Issues Found: Redundancy, AI-generated indicators, etc.
+
+## Items Requiring Attention
+
+### 1. [Title]
+- **Redundancy Score**: Medium/High
+- **Recommendation**: Needs review / Reject
+- **Issue**: [Specific problem identified]
+- **Verifier Feedback**: [Detailed feedback]
+- **Suggested Actions**: [What to do next]
+```
+
 ---
 
 ### Developer Pathway