create-genia-os 2.4.0 → 3.0.0

package/template/.aiox-core/development/templates/research-prompt-tmpl.md

@@ -0,0 +1,486 @@
+# Deep Research Prompt Template
+
+**Template ID:** research-prompt-template-v1
+**Purpose:** Generate structured deep research prompts for agent creation
+**Based On:** Meta-framework for Deep Research prompt construction
+
+---
+
+## Template Variables
+
+| Variable                   | Type   | Description              | Example                              |
+| -------------------------- | ------ | ------------------------ | ------------------------------------ |
+| `{{specialist_name}}`      | string | Human expert name        | "Gary Halbert"                       |
+| `{{specialist_slug}}`      | string | Slug format              | "gary_halbert"                       |
+| `{{activity}}`             | string | Specific activity        | "sales-page"                         |
+| `{{activity_expanded}}`    | string | Expanded description     | "Sales Page Creation"                |
+| `{{domain}}`               | string | Domain area              | "copywriting"                        |
+| `{{time_period}}`          | string | Relevant years           | "1970-2007"                          |
+| `{{agent_purpose}}`        | string | What agent does          | "Create high-converting sales pages" |
+| `{{local_knowledge_note}}` | string | What's already available | "Already have 3,520 lines..."        |
+| `{{scope_items}}`          | array  | 4-6 research angles      | [...]                                |
+| `{{requirements}}`         | array  | 3-4 research parameters  | [...]                                |
+| `{{sources}}`              | array  | 3-4 source types         | [...]                                |
+| `{{deliverables}}`         | array  | 3-5 expected outputs     | [...]                                |
+
+---
+
+## Prompt Template
+
+```markdown
+# Deep Research Prompt: {{specialist_name}} {{activity_expanded}} Methodology
+
+---
+
+## REFINED TOPIC
+
+"The {{activity_expanded}} Engineering of {{specialist_name}}: {{topic_description}} ({{time_period}})"
+
+---
+
+## CONTEXT
+
+{{context_paragraph}}
+
+---
+
+## SCOPE
+
+{{#each scope_items}}
+
+### {{this.number}}. {{this.title}}
+
+{{#each this.sub_points}}
+
+- {{this}}
+  {{/each}}
+
+{{/each}}
+
+---
+
+## REQUIREMENTS
+
+{{#each requirements}}
+{{this.number}}. {{this.text}}
+{{/each}}
+
+---
+
+## RECOMMENDED SOURCES
+
+{{#each sources}}
+
+- {{this}}
+  {{/each}}
+
+---
+
+## EXPECTED RESULTS
+
+{{#each deliverables}}
+{{this.number}}. "{{this.name}}" - {{this.description}}
+{{/each}}
+
+---
+
+## CLARIFYING QUESTIONS (Optional)
+
+{{#each clarifying_questions}}
+{{this.number}}. {{this.question}}
+{{/each}}
+
+---
+
+## RESEARCH NOTES
+
+{{#if local_knowledge_note}}
+**Existing Material:** {{local_knowledge_note}}
+**Research Mode:** Complementary (focus on gaps)
+{{else}}
+**Existing Material:** None found
+**Research Mode:** Comprehensive
+{{/if}}
+```
+
+---
+
+## Pre-Built Scope Templates by Domain
+
+### Copywriting (Specialist-Based)
+
+```yaml
+scope_templates:
+  copywriting:
+    - title: "{{SPECIALIST_NAME}}'S CORE METHODOLOGY"
+      sub_points:
+        - 'Fundamental principles and rules (explicit statements)'
+        - 'Process/workflow from start to finish'
+        - 'Quality criteria they used to evaluate work'
+        - 'What they considered mistakes/anti-patterns'
+
+    - title: '{{OUTPUT_TYPE}} ANATOMY/STRUCTURE'
+      sub_points:
+        - 'Section-by-section breakdown'
+        - 'Purpose of each section'
+        - 'Transitions between sections'
+        - 'Length/proportion guidelines'
+
+    - title: 'REAL EXAMPLES ANALYZED'
+      sub_points:
+        - "{{Specialist}}'s best known works"
+        - 'Line-by-line or section-by-section analysis'
+        - 'What made them effective'
+        - 'Common patterns across winners'
+
+    - title: 'CREATION PROCESS'
+      sub_points:
+        - 'Research phase before writing'
+        - 'Drafting methodology'
+        - 'Revision and editing process'
+        - 'Testing and iteration'
+
+    - title: 'MODERN ADAPTATION (2025)'
+      sub_points:
+        - 'Digital equivalents of original techniques'
+        - 'What principles remain timeless'
+        - 'What needs adjustment for modern context'
+        - 'Platform-specific considerations'
+
+    - title: 'QUALITY CRITERIA & CHECKLISTS'
+      sub_points:
+        - 'How {{specialist}} evaluated their own work'
+        - 'Red flags and warning signs'
+        - 'Approval criteria before shipping'
+        - 'Comparison: excellent vs weak examples'
+```
+
+### Product Management (Generic)
+
+```yaml
+scope_templates:
+  product_management:
+    - title: 'FRAMEWORK COMPARISON'
+      sub_points:
+        - 'Major frameworks in this area'
+        - 'When to use which approach'
+        - 'Pros/cons of each'
+        - 'Integration possibilities'
+
+    - title: 'PROCESS & METHODOLOGY'
+      sub_points:
+        - 'Step-by-step workflow'
+        - 'Key decision points'
+        - 'Inputs and outputs at each stage'
+        - 'Time allocation guidelines'
+
+    - title: 'TECHNIQUES & TOOLS'
+      sub_points:
+        - 'Specific techniques with how-to'
+        - 'Tools that support the process'
+        - 'Templates and artifacts'
+        - 'Facilitation approaches'
+
+    - title: 'CASE STUDIES'
+      sub_points:
+        - 'Real-world examples'
+        - 'What worked and why'
+        - 'What failed and lessons learned'
+        - 'Metrics and outcomes'
+
+    - title: 'COMMON MISTAKES'
+      sub_points:
+        - 'Anti-patterns to avoid'
+        - 'Warning signs of problems'
+        - 'Recovery strategies'
+        - 'Prevention techniques'
+```
+
+### Sales (Specialist-Based)
+
+```yaml
+scope_templates:
+  sales:
+    - title: "{{SPECIALIST_NAME}}'S SALES PHILOSOPHY"
+      sub_points:
+        - 'Core beliefs about selling'
+        - 'Mindset and approach'
+        - 'Relationship to customer'
+        - 'Ethics and boundaries'
+
+    - title: '{{OUTPUT_TYPE}} STRUCTURE'
+      sub_points:
+        - 'Opening/hook methodology'
+        - 'Discovery/qualification process'
+        - 'Presentation framework'
+        - 'Objection handling'
+        - 'Closing techniques'
+
+    - title: 'SCRIPTS & LANGUAGE'
+      sub_points:
+        - 'Exact phrases that work'
+        - 'Questions to ask'
+        - 'Transitions between phases'
+        - 'Language to avoid'
+
+    - title: 'REAL EXAMPLES'
+      sub_points:
+        - 'Documented sales/deals'
+        - 'What made them work'
+        - 'Variations for different contexts'
+
+    - title: 'METRICS & OPTIMIZATION'
+      sub_points:
+        - 'Key performance indicators'
+        - 'How to measure effectiveness'
+        - 'Iteration methodology'
+```
+
+---
+
+## Requirements Templates by Research Mode
+
+### Comprehensive (No Local Knowledge)
+
+```yaml
+requirements_comprehensive:
+  - "Prioritize primary sources (expert's own words, original works)"
+  - 'Include detailed analysis of at least 3 real examples'
+  - 'Extract operational processes, not just theory'
+  - 'Document both what TO DO and what NOT to do'
+```
+
+### Complementary (Has Local Knowledge)
+
+```yaml
+requirements_complementary:
+  - 'Focus on gaps not covered in existing material: {{gaps_list}}'
+  - 'Cross-reference with local sources for consistency'
+  - 'Prioritize new examples not already documented'
+  - 'Add modern context and digital adaptation'
+```
+
+---
+
+## Sources Templates by Domain
+
+### Copywriting
+
+```yaml
+sources_copywriting:
+  specialist_based:
+    - '"{{book_title}}" by {{specialist_name}} (especially {{chapters}})'
+    - '{{specialist_name}} newsletter/letter archive'
+    - 'Seminars and interviews with {{specialist_name}}'
+    - 'Analysis by practitioners who studied {{specialist_name}}'
+
+  generic:
+    - 'Classic copywriting books (Ogilvy, Hopkins, Schwartz)'
+    - 'AWAI and industry training materials'
+    - 'Case studies from successful campaigns'
+    - 'Academic research on persuasion'
+```
+
+### Product Management
+
+```yaml
+sources_product:
+  - '"The Mom Test" by Rob Fitzpatrick'
+  - '"Continuous Discovery Habits" by Teresa Torres'
+  - '"Inspired" by Marty Cagan'
+  - "Product management blogs (Lenny's Newsletter, etc.)"
+```
+
+### Sales
+
+```yaml
+sources_sales:
+  specialist_based:
+    - 'Books by {{specialist_name}}'
+    - 'Training programs and courses'
+    - 'Podcast/interview appearances'
+    - 'Practitioner testimonials and case studies'
+
+  generic:
+    - 'SPIN Selling, Challenger Sale, etc.'
+    - 'Sales methodology comparisons'
+    - 'CRM and sales enablement research'
+```
+
+---
+
+## Deliverables Templates
+
+### Standard Deliverables Set
+
+```yaml
+deliverables_standard:
+  - name: '{{Activity}} Structure Template'
+    description: 'Complete anatomy with all sections and their purposes'
+
+  - name: '{{Specialist}} Process Workflow'
+    description: 'Step-by-step methodology from research to completion'
+
+  - name: 'Quality Checklist'
+    description: 'Validation criteria derived from expert standards'
+
+  - name: 'Examples Database'
+    description: '{{N}}+ real examples with structural analysis'
+
+  - name: 'Anti-Patterns Guide'
+    description: 'Common mistakes and how to avoid them'
+```
+
+### Extended Deliverables (Deep Research)
+
+```yaml
+deliverables_extended:
+  - name: '{{Activity}} Blueprint'
+    description: 'Master template with all sections, purposes, and examples'
+
+  - name: 'Phrase/Language Bank'
+    description: '{{N}}+ proven phrases, openings, transitions, closes'
+
+  - name: 'Decision Framework'
+    description: 'When to use which approach/variation'
+
+  - name: 'Adaptation Guide'
+    description: 'How to modify for different contexts/audiences'
+
+  - name: 'Measurement Framework'
+    description: 'How to evaluate effectiveness'
+```
+
+---
+
+## Example: Fully Rendered Prompt
+
+### Input Variables
+
+```yaml
+specialist_name: 'Eugene Schwartz'
+specialist_slug: 'eugene_schwartz'
+activity: 'headlines'
+activity_expanded: 'Headline Creation'
+domain: 'copywriting'
+time_period: '1950-1995'
+agent_purpose: 'Create headlines that capture attention and qualify prospects'
+local_knowledge_note: "Have 'Breakthrough Advertising' excerpts (450 lines)"
+```
+
+### Rendered Output
+
+```markdown
+# Deep Research Prompt: Eugene Schwartz Headline Creation Methodology
+
+---
+
+## REFINED TOPIC
+
+"The Headline Engineering of Eugene Schwartz: The 5 Levels of Awareness Applied
+to Title Construction that Captures Attention and Qualifies Prospects (1950-1995)"
+
+---
+
+## CONTEXT
+
+Building an AI agent to create headlines that capture attention and qualify
+prospects following Eugene Schwartz's REAL methodology. Already have 450 lines
+from "Breakthrough Advertising" excerpts. Need to extract operational frameworks
+for headline creation across all awareness levels, with real examples and
+testing methodology.
+
+---
+
+## SCOPE
+
+### 1. THE 5 AWARENESS LEVELS IN PRACTICE (Not Theory)
+
+- Unaware: headlines that worked, common structure
+- Problem Aware: headlines that worked, common structure
+- Solution Aware: headlines that worked, common structure
+- Product Aware: headlines that worked, common structure
+- Most Aware: headlines that worked, common structure
+- How to DIAGNOSE which level the market is at
+
+### 2. HEADLINE CREATION MECHANISM
+
+- Schwartz's 33-minute work block process
+- How many headlines he created before choosing
+- Selection criteria: what made a headline "winner"
+- Swipe file usage: how he used references
+
+### 3. RECURRING STRUCTURES
+
+- Identifiable patterns in Schwartz headlines
+- "Power words" he used repeatedly
+- Mathematical headline formulas (if they existed)
+- Ideal length by context
+
+### 4. MARKET SOPHISTICATION (Different from Awareness)
+
+- The 5 levels of sophistication
+- How this affected the headline
+- When to use "new" vs "improved" vs "different"
+- Saturated markets vs virgin markets
+
+### 5. DOCUMENTED CASES
+
+- Headlines from "Breakthrough Advertising"
+- Mail order headlines he wrote
+- Documented A/B test results
+- Headlines rejected vs approved (if documented)
+
+---
+
+## REQUIREMENTS
+
+1. Prioritize "Breakthrough Advertising" as primary source
+2. Include REAL headlines with structural analysis
+3. Differentiate theory (book) from practice (real campaigns)
+4. Extract operational checklists and decision criteria
+
+---
+
+## RECOMMENDED SOURCES
+
+- "Breakthrough Advertising" (complete, focusing on examples)
+- Schwartz's mail order ads (Rodale, Boardroom)
+- Interviews with Schwartz (rare, but exist)
+- Brian Kurtz's analysis of Schwartz
+- Boardroom Inc. archives
+
+---
+
+## EXPECTED RESULTS
+
+1. "Awareness Level Diagnostic Tool" - How to identify market level
+2. "Headline Templates by Level" - 5-10 structures for each level
+3. "Schwartz Headline Creation Process" - Documented workflow
+4. "Sophistication Assessment Matrix" - Decision diagram
+5. "50 Headlines Analyzed" - Database with structure, level, result
+
+---
+
+## RESEARCH NOTES
+
+**Existing Material:** 450 lines from Breakthrough Advertising excerpts
+**Research Mode:** Complementary (focus on real examples and process details)
+**Gaps to Fill:** Testing methodology, more real headline examples, sophistication framework
+```
+
+---
+
+## Usage Notes
+
+1. **Variable Substitution:** Replace all `{{variables}}` with actual values
+2. **Scope Selection:** Choose 4-6 most relevant angles from templates
+3. **Adaptation:** Modify sub-points based on specific agent purpose
+4. **Local Knowledge:** Adjust research mode based on existing material
+5. **YOLO Mode:** Skip clarifying questions in autonomous execution
+
+---
+
+**Template Version:** 1.0.0
+**Created:** 2026-01-22
+**Part of:** squads/squad-architect

package/template/.aiox-core/development/templates/service-template/README.md.hbs

@@ -0,0 +1,158 @@
+# {{pascalCase serviceName}} Service
+
+> {{description}}
+
+## Installation
+
+```bash
+npm install @aiox/{{kebabCase serviceName}}
+```
+
+## Quick Start
+
+```typescript
+import { create{{pascalCase serviceName}}Service } from '@aiox/{{kebabCase serviceName}}';
+
+const service = create{{pascalCase serviceName}}Service({
+{{#each envVars}}
+  {{camelCase this.name}}: process.env.{{this.name}},
+{{/each}}
+});
+
+// Use the service
+const result = await service.execute();
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+{{#each envVars}}
+| `{{this.name}}` | {{#if this.required}}Yes{{else}}No{{/if}} | {{this.description}} |
+{{/each}}
+
+### Programmatic Configuration
+
+```typescript
+import { create{{pascalCase serviceName}}Service, {{pascalCase serviceName}}Config } from '@aiox/{{kebabCase serviceName}}';
+
+const config: {{pascalCase serviceName}}Config = {
+{{#each envVars}}
+  {{camelCase this.name}}: '{{this.example}}',
+{{/each}}
+};
+
+const service = create{{pascalCase serviceName}}Service(config);
+```
+
+{{#if isApiIntegration}}
+## API Integration
+
+This service integrates with an external API. Features include:
+
+- **Rate Limiting**: Automatic request throttling
+- **Retry Logic**: Exponential backoff on failures
+- **Error Handling**: Typed errors with actionable messages
+
+### Rate Limits
+
+> **Note:** The values below are placeholders. Update them according to your API's actual rate limits.
+
+| Tier | Requests/min | Burst |
+|------|--------------|-------|
+| Free | 60 | 10 |
+| Pro | 600 | 100 |
+
+{{/if}}
+## Usage Examples
+
+### Basic Usage
+
+```typescript
+const service = create{{pascalCase serviceName}}Service(config);
+
+try {
+  const result = await service.execute();
+  console.log('Success:', result);
+} catch (error) {
+  if (error instanceof {{pascalCase serviceName}}Error) {
+    console.error('Service error:', error.code, error.message);
+  }
+  throw error;
+}
+```
+
+{{#if hasAuth}}
+### Authentication
+
+This service requires authentication. Set your credentials via environment variables or config:
+
+```typescript
+const service = create{{pascalCase serviceName}}Service({
+  apiKey: process.env.{{upperCase serviceName}}_API_KEY,
+  // or
+  accessToken: process.env.{{upperCase serviceName}}_ACCESS_TOKEN,
+});
+```
+
+{{/if}}
+## Error Handling
+
+The service provides typed errors for common failure scenarios:
+
+```typescript
+import { {{pascalCase serviceName}}Error, {{pascalCase serviceName}}ErrorCode } from '@aiox/{{kebabCase serviceName}}';
+
+try {
+  await service.execute();
+} catch (error) {
+  if (error instanceof {{pascalCase serviceName}}Error) {
+    switch (error.code) {
+      case {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR:
+        // Handle configuration issues
+        break;
+      case {{pascalCase serviceName}}ErrorCode.NETWORK_ERROR:
+        // Handle network issues
+        break;
+{{#if isApiIntegration}}
+      case {{pascalCase serviceName}}ErrorCode.RATE_LIMIT_EXCEEDED:
+        // Handle rate limiting
+        break;
+{{/if}}
+      default:
+        // Handle other errors
+    }
+  }
+}
+```
+
+## API Reference
+
+See the [TypeScript definitions](./dist/types.d.ts) for complete API documentation.
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Build
+npm run build
+
+# Type check
+npm run typecheck
+```
+
+## License
+
+MIT
+
+---
+
+*Generated by AIOX-FullStack Service Template*
+*Story: {{storyId}}*