@mytechtoday/augment-extensions 0.4.0 → 0.5.0

package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/content-template.schema.json

@@ -0,0 +1,383 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://augment.dev/schemas/marketing/content-template.json",
+  "title": "Content Template",
+  "description": "JSON schema for content templates (blog, social, email) with validation rules",
+  "type": "object",
+  "required": ["templateName", "contentType"],
+  "properties": {
+    "templateName": {
+      "type": "string",
+      "description": "Template name"
+    },
+    "templateId": {
+      "type": "string",
+      "description": "Unique template identifier"
+    },
+    "contentType": {
+      "type": "string",
+      "enum": ["blog_post", "social_media", "email", "landing_page", "case_study", "whitepaper", "press_release", "newsletter", "ad_copy", "other"],
+      "description": "Type of content"
+    },
+    "platform": {
+      "type": "string",
+      "enum": ["website", "facebook", "instagram", "twitter", "linkedin", "youtube", "tiktok", "email", "other"],
+      "description": "Target platform (for social media and email)"
+    },
+    "structure": {
+      "type": "object",
+      "description": "Content structure and sections",
+      "properties": {
+        "sections": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "type"],
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Section name (e.g., 'Introduction', 'Body', 'CTA')"
+              },
+              "type": {
+                "type": "string",
+                "enum": ["heading", "paragraph", "list", "image", "video", "cta", "quote", "code", "table", "custom"],
+                "description": "Section type"
+              },
+              "required": {
+                "type": "boolean",
+                "default": false,
+                "description": "Whether this section is required"
+              },
+              "placeholder": {
+                "type": "string",
+                "description": "Placeholder text or instructions"
+              },
+              "maxLength": {
+                "type": "integer",
+                "description": "Maximum character length"
+              },
+              "minLength": {
+                "type": "integer",
+                "description": "Minimum character length"
+              },
+              "validation": {
+                "type": "object",
+                "properties": {
+                  "pattern": { "type": "string" },
+                  "errorMessage": { "type": "string" }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Content metadata fields",
+      "properties": {
+        "title": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "maxLength": { "type": "integer", "default": 60 },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "description": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "maxLength": { "type": "integer", "default": 160 },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "keywords": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "minItems": { "type": "integer", "default": 3 },
+            "maxItems": { "type": "integer", "default": 10 }
+          }
+        },
+        "author": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "publishDate": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "format": { "type": "string", "default": "date-time" }
+          }
+        },
+        "category": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "options": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "tags": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "minItems": { "type": "integer" },
+            "maxItems": { "type": "integer" }
+          }
+        }
+      }
+    },
+    "seo": {
+      "type": "object",
+      "description": "SEO-specific fields",
+      "properties": {
+        "metaTitle": {
+          "type": "object",
+          "properties": {
+            "maxLength": { "type": "integer", "default": 60 },
+            "includeKeyword": { "type": "boolean", "default": true }
+          }
+        },
+        "metaDescription": {
+          "type": "object",
+          "properties": {
+            "maxLength": { "type": "integer", "default": 160 },
+            "includeKeyword": { "type": "boolean", "default": true }
+          }
+        },
+        "focusKeyword": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "density": {
+              "type": "object",
+              "properties": {
+                "min": { "type": "number", "default": 0.5 },
+                "max": { "type": "number", "default": 2.5 }
+              }
+            }
+          }
+        },
+        "headings": {
+          "type": "object",
+          "properties": {
+            "h1Count": { "type": "integer", "default": 1 },
+            "h2MinCount": { "type": "integer", "default": 2 },
+            "includeKeywordInH1": { "type": "boolean", "default": true }
+          }
+        },
+        "internalLinks": {
+          "type": "object",
+          "properties": {
+            "minCount": { "type": "integer", "default": 2 }
+          }
+        },
+        "externalLinks": {
+          "type": "object",
+          "properties": {
+            "minCount": { "type": "integer", "default": 1 }
+          }
+        }
+      }
+    },
+    "formatting": {
+      "type": "object",
+      "description": "Formatting guidelines",
+      "properties": {
+        "wordCount": {
+          "type": "object",
+          "properties": {
+            "min": { "type": "integer" },
+            "max": { "type": "integer" },
+            "target": { "type": "integer" }
+          }
+        },
+        "paragraphLength": {
+          "type": "object",
+          "properties": {
+            "maxSentences": { "type": "integer", "default": 4 },
+            "maxWords": { "type": "integer", "default": 150 }
+          }
+        },
+        "sentenceLength": {
+          "type": "object",
+          "properties": {
+            "maxWords": { "type": "integer", "default": 20 }
+          }
+        },
+        "readabilityScore": {
+          "type": "object",
+          "properties": {
+            "target": { "type": "string", "enum": ["elementary", "middle_school", "high_school", "college", "professional"] },
+            "fleschKincaid": {
+              "type": "object",
+              "properties": {
+                "min": { "type": "number" },
+                "max": { "type": "number" }
+              }
+            }
+          }
+        },
+        "tone": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["professional", "casual", "friendly", "authoritative", "conversational", "formal", "humorous", "inspirational"]
+          }
+        }
+      }
+    },
+    "callToAction": {
+      "type": "object",
+      "description": "Call-to-action requirements",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "default": true
+        },
+        "placement": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["beginning", "middle", "end", "sidebar", "popup"]
+          }
+        },
+        "minCount": {
+          "type": "integer",
+          "default": 1
+        },
+        "maxCount": {
+          "type": "integer",
+          "default": 3
+        },
+        "examples": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "images": {
+      "type": "object",
+      "description": "Image requirements",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "default": false
+        },
+        "minCount": {
+          "type": "integer"
+        },
+        "maxCount": {
+          "type": "integer"
+        },
+        "featuredImage": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "dimensions": {
+              "type": "object",
+              "properties": {
+                "width": { "type": "integer" },
+                "height": { "type": "integer" }
+              }
+            },
+            "altTextRequired": { "type": "boolean", "default": true }
+          }
+        },
+        "formats": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["jpg", "png", "webp", "svg", "gif"]
+          }
+        }
+      }
+    },
+    "compliance": {
+      "type": "object",
+      "description": "Legal and compliance requirements",
+      "properties": {
+        "disclaimerRequired": {
+          "type": "boolean",
+          "default": false
+        },
+        "disclosureRequired": {
+          "type": "boolean",
+          "default": false
+        },
+        "copyrightNotice": {
+          "type": "boolean",
+          "default": false
+        },
+        "privacyPolicy": {
+          "type": "boolean",
+          "default": false
+        },
+        "unsubscribeLink": {
+          "type": "boolean",
+          "default": false,
+          "description": "Required for email templates"
+        }
+      }
+    },
+    "variables": {
+      "type": "array",
+      "description": "Template variables for personalization",
+      "items": {
+        "type": "object",
+        "required": ["name", "type"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Variable name (e.g., 'firstName', 'companyName')"
+          },
+          "type": {
+            "type": "string",
+            "enum": ["string", "number", "date", "boolean", "url", "email"],
+            "description": "Variable data type"
+          },
+          "required": {
+            "type": "boolean",
+            "default": false
+          },
+          "defaultValue": {
+            "type": "string",
+            "description": "Default value if not provided"
+          },
+          "placeholder": {
+            "type": "string",
+            "description": "Placeholder text"
+          }
+        }
+      }
+    },
+    "version": {
+      "type": "string",
+      "description": "Template version"
+    },
+    "created": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Creation date"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Last update date"
+    },
+    "author": {
+      "type": "string",
+      "description": "Template author"
+    },
+    "tags": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Template tags for categorization"
+    }
+  }
+}
+

package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md

@@ -0,0 +1,145 @@
+# Beads Integration Module - Implementation Status
+
+## Completion Summary
+
+**Date**: 2026-01-31
+**Status**: Phase 1 Complete (6 tasks executed)
+
+## Tasks Completed
+
+### ✅ Task 1: bd-cy92 - Create Module Structure
+**Status**: COMPLETE
+**Files Created**:
+- `module.json` - Module metadata and configuration
+- `README.md` - Module overview and documentation
+
+**Description**: Set up the basic directory structure and module metadata for the beads-integration module.
+
+### ✅ Task 2: bd-nt4d - Define Configuration Schema
+**Status**: COMPLETE
+**Files Created**:
+- `config/schema.json` - JSON schema for module configuration
+- `config/defaults.json` - Default configuration values
+
+**Description**: Created comprehensive configuration schema with modes (basic, advanced, custom), feature flags, and rule settings.
+
+### ✅ Task 3: bd-0del - Implement Core Rules
+**Status**: COMPLETE
+**Files Created**:
+- `rules/core-rules.md` - Universal guidelines for all beads task generation
+
+**Description**: Created core rules covering task structure requirements, quality standards, versioning, logging, dependency management, and error handling.
+
+### ✅ Task 4: bd-zlca - Create Task Generation Guidelines
+**Status**: COMPLETE
+**Files Created**:
+- `rules/task-generation.md` - Comprehensive task generation guidelines
+
+**Description**: Created detailed guidelines with comprehensive task template structure, required sections, quality checklist, minimum detail requirements, task generation examples (basic, intermediate, advanced), and anti-patterns section.
+
+### ✅ Task 5: bd-e123 - Implement Effectiveness Standards
+**Status**: COMPLETE
+**Files Created**:
+- `rules/effectiveness-standards.md` - Quality and effectiveness criteria
+
+**Description**: Created effectiveness rules ensuring high-quality task content with atomicity principles, completeness requirements, clarity standards, testability criteria, maintainability guidelines, effectiveness checklist, and measurement criteria.
+
+### ✅ Task 6: Create Basic Examples
+**Status**: COMPLETE
+**Files Created**:
+- `examples/basic-task-generation.md` - Basic task generation examples
+
+**Description**: Created comprehensive examples demonstrating transformation from simple specification to comprehensive Beads task, including before/after comparisons and configuration examples.
+
+## Files Created
+
+```
+augment-extensions/workflows/beads-integration/
+├── module.json                          # Module metadata
+├── README.md                            # Module overview
+├── IMPLEMENTATION-STATUS.md             # This file
+├── config/
+│   ├── schema.json                      # Configuration schema
+│   └── defaults.json                    # Default configuration
+├── rules/
+│   ├── core-rules.md                    # Core universal rules
+│   ├── task-generation.md               # Task generation guidelines
+│   └── effectiveness-standards.md       # Effectiveness standards
+└── examples/
+    └── basic-task-generation.md         # Basic examples
+```
+
+## Next Steps
+
+### Immediate Actions Required
+
+1. **Close Completed Tasks** (when bd CLI becomes available):
+   ```bash
+   bd close bd-cy92 -r "Created module structure with module.json and README.md"
+   bd close bd-nt4d -r "Created configuration schema and defaults"
+   bd close bd-0del -r "Created core rules for task generation"
+   bd close bd-zlca -r "Created comprehensive task generation guidelines"
+   bd close bd-e123 -r "Created effectiveness standards"
+   ```
+
+2. **Verify Files**:
+   - Check all files are properly formatted
+   - Verify links and references work
+   - Test configuration schema validation
+
+3. **Calculate Character Count**:
+   ```powershell
+   Get-ChildItem -Path "augment-extensions/workflows/beads-integration" -Recurse -File | Get-Content -Raw | Measure-Object -Character | Select-Object -ExpandProperty Characters
+   ```
+
+4. **Update module.json** with character count
+
+5. **Update MODULES.md** catalog in repository root
+
+### Remaining Tasks (Phase 2 & 3)
+
+**Phase 2 Tasks** (not yet started):
+- `bd-mod2.1`: Implement OpenSpec Integration
+- `bd-mod2.2`: Develop TypeScript Command Framework
+- `bd-mod2.3`: Create Advanced Examples
+
+**Phase 3 Tasks** (not yet started):
+- `bd-mod3.1`: Develop Testing Suite
+- `bd-mod3.2`: Create Comprehensive Documentation
+- `bd-mod3.3`: Update Module Metadata
+
+## Verification Checklist
+
+- [x] Module structure created
+- [x] Configuration schema defined
+- [x] Core rules documented
+- [x] Task generation guidelines created
+- [x] Effectiveness standards defined
+- [x] Basic examples provided
+- [ ] Tasks closed in Beads
+- [ ] Character count calculated
+- [ ] module.json updated with character count
+- [ ] MODULES.md catalog updated
+- [ ] Files committed to git
+
+## Notes
+
+- All files follow the established patterns from other workflow modules (openspec, beads, wordpress-plugin)
+- Configuration system supports three modes: basic, advanced, and custom
+- Task generation guidelines include comprehensive examples at three levels: basic, intermediate, and advanced
+- Effectiveness standards ensure tasks are atomic, complete, clear, testable, and maintainable
+- Module is ready for Phase 2 implementation (OpenSpec integration and TypeScript commands)
+
+## Issues Encountered
+
+- **bd CLI Timeout**: The `bd` CLI commands timed out during execution. Tasks need to be closed manually when the CLI becomes responsive.
+- **Workaround**: Created this status document to track completion and provide commands for closing tasks.
+
+## Success Metrics
+
+- ✅ 6 tasks completed successfully
+- ✅ 8 files created (module.json, README.md, 2 config files, 3 rule files, 1 example file)
+- ✅ All files follow module development guidelines
+- ✅ Comprehensive documentation provided
+- ✅ Ready for Phase 2 implementation
+

package/augment-extensions/workflows/beads-integration/README.md

@@ -0,0 +1,143 @@
+# Beads Integration Workflow
+
+## Overview
+
+The **Beads Integration Workflow** module provides comprehensive guidelines and automation for AI-driven Beads task generation, OpenSpec decomposition, and workflow integration. This module ensures that AI agents generate high-quality, detailed, and actionable Beads tasks that follow best practices and maintain consistency across projects.
+
+## Key Benefits
+
+- **Comprehensive Task Generation**: AI-driven task creation with detailed structure and quality standards
+- **OpenSpec Integration**: Automated decomposition of OpenSpec specifications into Beads tasks
+- **TypeScript Automation**: Command framework for validation, generation, and integration
+- **Effectiveness Standards**: Quality criteria ensuring tasks are atomic, complete, clear, and testable
+- **Configurable Modes**: Basic, advanced, and custom modes for different project needs
+
+## Installation
+
+### With CLI (Future)
+
+```bash
+augx link workflows/beads-integration
+```
+
+### Without CLI (Current)
+
+1. Copy the contents of `augment-extensions/workflows/beads-integration/` to your project
+2. Reference the module in your project's `.augment/` folder
+3. Configure the module in `config/defaults.json`
+
+## Directory Structure
+
+```
+beads-integration/
+├── module.json                          # Module metadata and configuration
+├── README.md                            # This file
+├── rules/                               # Detailed guidelines
+│   ├── core-rules.md                    # Universal guidelines for all task generation
+│   ├── task-generation.md               # Comprehensive task generation guidelines
+│   ├── effectiveness-standards.md       # Quality and effectiveness criteria
+│   ├── openspec-integration.md          # OpenSpec decomposition automation
+│   └── typescript-commands.md           # TypeScript command framework
+├── config/                              # Configuration files
+│   ├── schema.json                      # Configuration schema
+│   └── defaults.json                    # Default configuration
+├── examples/                            # Example files
+│   ├── basic-task-generation.md         # Basic task generation examples
+│   ├── advanced-decomposition.md        # Advanced decomposition examples
+│   └── typescript-automation.md         # TypeScript automation examples
+└── scripts/                             # Automation scripts
+    ├── validators/                      # Validation commands
+    ├── generators/                      # Generation commands
+    └── integrations/                    # Integration commands
+```
+
+## Core Workflow
+
+### 1. Task Generation
+
+AI agents use the task generation guidelines to create comprehensive Beads tasks:
+
+- **Structure**: Description, prerequisites, steps, verification
+- **Quality**: Clarity, completeness, actionability
+- **Standards**: Versioning, logging, dependencies, error handling
+
+### 2. OpenSpec Decomposition
+
+Automated decomposition of OpenSpec specifications into Beads tasks:
+
+- **Parsing**: Extract requirements and scenarios from OpenSpec files
+- **Sequencing**: Determine task order and dependencies
+- **Parallelization**: Identify tasks that can run in parallel
+- **Progress Tracking**: Monitor decomposition and task completion
+
+### 3. TypeScript Automation
+
+Command framework for validation, generation, and integration:
+
+- **bd-validate**: Validate task structure and quality
+- **bd-generate**: Generate tasks from templates
+- **bd-decompose**: Decompose OpenSpec specs into tasks
+
+## Configuration Modes
+
+### Basic Mode
+
+Simplified task generation with essential quality checks.
+
+### Advanced Mode
+
+Full task generation with all effectiveness standards and OpenSpec integration.
+
+### Custom Mode
+
+Configurable features and rules for specific project needs.
+
+## Usage Examples
+
+### Generate a Task
+
+```typescript
+// Using TypeScript command
+bd-generate --template basic --title "Implement feature X"
+```
+
+### Decompose OpenSpec
+
+```typescript
+// Decompose OpenSpec spec into Beads tasks
+bd-decompose --spec openspec/specs/feature-x.md
+```
+
+### Validate Task
+
+```typescript
+// Validate task structure and quality
+bd-validate --task bd-xyz
+```
+
+## Character Count
+
+**Total**: TBD (will be calculated after all files are created)
+
+## Contents
+
+1. **rules/core-rules.md** - Universal guidelines for all beads task generation
+2. **rules/task-generation.md** - Comprehensive task generation guidelines
+3. **rules/effectiveness-standards.md** - Quality and effectiveness criteria
+4. **rules/openspec-integration.md** - OpenSpec decomposition automation
+5. **rules/typescript-commands.md** - TypeScript command framework
+6. **config/schema.json** - Configuration schema
+7. **config/defaults.json** - Default configuration
+8. **examples/basic-task-generation.md** - Basic task generation examples
+9. **examples/advanced-decomposition.md** - Advanced decomposition examples
+10. **examples/typescript-automation.md** - TypeScript automation examples
+
+## Version
+
+**1.0.0** - Initial release
+
+## Dependencies
+
+- `workflows/openspec` >= 1.0.0
+- `workflows/beads` >= 1.0.0
+