aiox-core 5.0.2 → 5.0.3

package/pro/squads/squad-creator-pro/templates/research-output-tmpl.md

@@ -0,0 +1,625 @@
+# Deep Research Output Template
+
+**Template ID:** research-output-template-v1
+**Purpose:** Standardized structure for deep research documents
+**Validates Against:** `checklists/deep-research-quality.md`
+
+---
+
+## Template Variables
+
+> **Nota:** Exemplos usam copywriting. Substitua pelo seu domínio e experts.
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `{{specialist_name}}` | Expert name | "{expert-name}" |
+| `{{activity}}` | Specific activity | "{activity-name}" |
+| `{{domain}}` | Domain area | "{domain}" |
+| `{{date}}` | Research date | "2026-01-22" |
+| `{{agent_purpose}}` | What agent will do | "{agent-purpose-description}" |
+
+---
+
+## Document Template
+
+```markdown
+# Deep Research: {{specialist_name}} {{activity}} Methodology
+
+**Generated:** {{date}}
+**Domain:** {{domain}}
+**Agent Purpose:** {{agent_purpose}}
+**Specialist:** {{specialist_name}}
+
+---
+
+## Executive Summary
+
+{{executive_summary}}
+
+**Key Findings:**
+- {{finding_1}}
+- {{finding_2}}
+- {{finding_3}}
+
+**Framework Identified:** {{framework_name}}
+**Primary Sources Used:** {{primary_source_count}}
+**Confidence Level:** {{confidence_high|medium|low}}
+
+---
+
+## 1. {{scope_section_1_title}}
+
+### Overview
+
+{{section_1_overview}}
+
+### Key Findings
+
+{{section_1_findings}}
+
+### Primary Evidence
+
+> "{{quote_from_expert}}"
+> — {{source}}, {{year}}
+
+(PRIMARY) {{evidence_description}}
+
+### Extracted Insights
+
+- **Principle:** {{principle}}
+- **Process:** {{process_step}}
+- **Rule:** {{rule}}
+
+### Examples
+
+**Example 1: {{example_name}}**
+
+{{example_description}}
+
+**Analysis:**
+{{what_makes_it_work}}
+
+**Lessons:**
+- {{lesson_1}}
+- {{lesson_2}}
+
+---
+
+## 2. {{scope_section_2_title}}
+
+### Overview
+
+{{section_2_overview}}
+
+### Key Findings
+
+{{section_2_findings}}
+
+### Primary Evidence
+
+> "{{quote_from_expert}}"
+> — {{source}}, {{year}}
+
+### Extracted Insights
+
+{{insights}}
+
+### Examples
+
+{{examples}}
+
+---
+
+## 3. {{scope_section_3_title}}
+
+{{repeat_structure}}
+
+---
+
+## 4. {{scope_section_4_title}}
+
+{{repeat_structure}}
+
+---
+
+## 5. {{scope_section_5_title}}
+
+{{repeat_structure}}
+
+---
+
+## 6. {{scope_section_6_title}}
+
+{{repeat_structure}}
+
+---
+
+## Consolidated Framework
+
+### {{framework_name}}
+
+**Source:** Based on {{specialist_name}}'s documented methodology
+**Validated By:** {{validation_sources}}
+
+---
+
+### Principles
+
+{{specialist_name}}'s core principles for {{activity}}:
+
+1. **{{principle_1_name}}**
+   > "{{principle_1_quote}}" — {{source}}
+
+   {{principle_1_explanation}}
+
+2. **{{principle_2_name}}**
+   > "{{principle_2_quote}}" — {{source}}
+
+   {{principle_2_explanation}}
+
+3. **{{principle_3_name}}**
+   {{principle_3_content}}
+
+4. **{{principle_4_name}}**
+   {{principle_4_content}}
+
+5. **{{principle_5_name}}**
+   {{principle_5_content}}
+
+---
+
+### Process
+
+{{specialist_name}}'s workflow for {{activity}}:
+
+```
+Step 1: {{step_1_name}}
+├── {{step_1_action_1}}
+├── {{step_1_action_2}}
+└── Output: {{step_1_output}}
+
+Step 2: {{step_2_name}}
+├── {{step_2_action_1}}
+├── {{step_2_action_2}}
+└── Output: {{step_2_output}}
+
+Step 3: {{step_3_name}}
+├── {{step_3_action_1}}
+├── {{step_3_action_2}}
+└── Output: {{step_3_output}}
+
+...continue for all steps...
+```
+
+**Detailed Steps:**
+
+**Step 1: {{step_1_name}}**
+
+{{step_1_detailed_description}}
+
+- **What to do:** {{what}}
+- **How to do it:** {{how}}
+- **{{specialist_name}}'s tip:** {{tip}}
+- **Common mistake:** {{mistake}}
+
+**Step 2: {{step_2_name}}**
+
+{{repeat_for_each_step}}
+
+---
+
+### Structure / Anatomy
+
+The anatomy of a {{output_type}} according to {{specialist_name}}:
+
+| Section | Purpose | {{specialist_name}}'s Rule | Example |
+|---------|---------|---------------------------|---------|
+| {{section_1}} | {{purpose_1}} | {{rule_1}} | {{example_1}} |
+| {{section_2}} | {{purpose_2}} | {{rule_2}} | {{example_2}} |
+| {{section_3}} | {{purpose_3}} | {{rule_3}} | {{example_3}} |
+| {{section_4}} | {{purpose_4}} | {{rule_4}} | {{example_4}} |
+| {{section_5}} | {{purpose_5}} | {{rule_5}} | {{example_5}} |
+| {{section_6}} | {{purpose_6}} | {{rule_6}} | {{example_6}} |
+| {{section_7}} | {{purpose_7}} | {{rule_7}} | {{example_7}} |
+| {{section_8}} | {{purpose_8}} | {{rule_8}} | {{example_8}} |
+
+**Section Details:**
+
+**{{section_1}}: {{purpose_1}}**
+
+{{detailed_guidance_for_section_1}}
+
+> "{{specialist_quote_about_section}}" — {{source}}
+
+**What works:**
+- {{what_works_1}}
+- {{what_works_2}}
+
+**What to avoid:**
+- {{what_to_avoid_1}}
+- {{what_to_avoid_2}}
+
+{{repeat_for_each_section}}
+
+---
+
+### Quality Criteria
+
+How {{specialist_name}} evaluated {{activity}}:
+
+**Excellent (What {{specialist_name}} considered great):**
+
+- [ ] {{excellent_criterion_1}}
+- [ ] {{excellent_criterion_2}}
+- [ ] {{excellent_criterion_3}}
+- [ ] {{excellent_criterion_4}}
+- [ ] {{excellent_criterion_5}}
+
+**Weak (What {{specialist_name}} criticized):**
+
+- [ ] {{weak_criterion_1}}
+- [ ] {{weak_criterion_2}}
+- [ ] {{weak_criterion_3}}
+- [ ] {{weak_criterion_4}}
+- [ ] {{weak_criterion_5}}
+
+**Red Flags (Immediate problems):**
+
+- [ ] {{red_flag_1}}
+- [ ] {{red_flag_2}}
+- [ ] {{red_flag_3}}
+
+---
+
+### Validation Checklist
+
+Derived from {{specialist_name}}'s quality criteria:
+
+**Before Starting:**
+- [ ] {{pre_check_1}}
+- [ ] {{pre_check_2}}
+- [ ] {{pre_check_3}}
+
+**During Creation:**
+- [ ] {{during_check_1}}
+- [ ] {{during_check_2}}
+- [ ] {{during_check_3}}
+- [ ] {{during_check_4}}
+- [ ] {{during_check_5}}
+
+**Final Review:**
+- [ ] {{final_check_1}}
+- [ ] {{final_check_2}}
+- [ ] {{final_check_3}}
+- [ ] {{final_check_4}}
+- [ ] {{final_check_5}}
+
+**{{specialist_name}}'s Ultimate Test:**
+> "{{ultimate_test_quote}}" — {{source}}
+
+---
+
+## Examples Analyzed
+
+### Example 1: {{example_1_name}}
+
+**Type:** {{type}}
+**Creator:** {{specialist_name}}
+**Date:** {{date}}
+**Result:** {{documented_result}}
+
+**The Example:**
+
+{{example_content_or_description}}
+
+**Line-by-Line Analysis:**
+
+| Element | What It Is | Why It Works | Principle Applied |
+|---------|------------|--------------|-------------------|
+| {{element_1}} | {{description}} | {{why_works}} | {{principle}} |
+| {{element_2}} | {{description}} | {{why_works}} | {{principle}} |
+| {{element_3}} | {{description}} | {{why_works}} | {{principle}} |
+
+**Key Takeaways:**
+1. {{takeaway_1}}
+2. {{takeaway_2}}
+3. {{takeaway_3}}
+
+---
+
+### Example 2: {{example_2_name}}
+
+{{repeat_structure}}
+
+---
+
+### Example 3: {{example_3_name}}
+
+{{repeat_structure}}
+
+---
+
+## Modern Adaptation ({{current_year}})
+
+### What Remains Timeless
+
+{{specialist_name}}'s principles that still apply:
+
+1. **{{timeless_1}}** — Why: {{explanation}}
+2. **{{timeless_2}}** — Why: {{explanation}}
+3. **{{timeless_3}}** — Why: {{explanation}}
+
+### What Needs Adaptation
+
+Changes for modern context:
+
+| Original ({{specialist_era}}) | Modern Equivalent | Adaptation Notes |
+|-------------------------------|-------------------|------------------|
+| {{original_1}} | {{modern_1}} | {{notes_1}} |
+| {{original_2}} | {{modern_2}} | {{notes_2}} |
+| {{original_3}} | {{modern_3}} | {{notes_3}} |
+
+### Platform-Specific Considerations
+
+**Digital/Web:**
+- {{digital_consideration_1}}
+- {{digital_consideration_2}}
+
+**Mobile:**
+- {{mobile_consideration_1}}
+- {{mobile_consideration_2}}
+
+**Social Media:**
+- {{social_consideration_1}}
+- {{social_consideration_2}}
+
+---
+
+## Common Mistakes
+
+### Mistakes {{specialist_name}} Identified
+
+1. **{{mistake_1_name}}**
+   > "{{mistake_quote}}" — {{source}}
+
+   **What it looks like:** {{description}}
+   **Why it fails:** {{explanation}}
+   **How to fix:** {{solution}}
+
+2. **{{mistake_2_name}}**
+   {{repeat_structure}}
+
+3. **{{mistake_3_name}}**
+   {{repeat_structure}}
+
+### Modern Mistakes (Added)
+
+1. **{{modern_mistake_1}}**
+   {{description_and_fix}}
+
+2. **{{modern_mistake_2}}**
+   {{description_and_fix}}
+
+---
+
+## Sources
+
+### Primary Sources (Tier 1)
+
+1. **{{book_title}}** by {{specialist_name}}, {{year}}
+   - Chapters referenced: {{chapters}}
+   - Key sections: {{sections}}
+
+2. **{{source_2_title}}** by {{specialist_name}}
+   - {{details}}
+
+3. **{{interview_transcript}}** — {{specialist_name}}, {{date}}
+   - {{details}}
+
+### Secondary Sources (Tier 2)
+
+4. **{{analysis_title}}** by {{author}}, {{year}}
+   - {{relevance}}
+
+5. **{{case_study_title}}** — {{source}}
+   - {{relevance}}
+
+### Supporting Sources (Tier 3)
+
+6. {{supporting_source_1}}
+7. {{supporting_source_2}}
+
+---
+
+## Research Metadata
+
+```yaml
+research_metadata:
+  document_id: "{{specialist_slug}}-{{activity_slug}}-research"
+  created: "{{date}}"
+  version: "1.0"
+
+  metrics:
+    total_lines: {{line_count}}
+    primary_sources: {{primary_count}}
+    secondary_sources: {{secondary_count}}
+    examples_analyzed: {{example_count}}
+    scope_coverage: "{{covered}}/{{total}}"
+
+  local_knowledge_used:
+    files: {{local_files_list}}
+    lines_from_local: {{local_lines}}
+    percentage: "{{local_percentage}}%"
+
+  web_research:
+    queries_executed: {{query_count}}
+    pages_fetched: {{fetch_count}}
+    lines_from_web: {{web_lines}}
+    percentage: "{{web_percentage}}%"
+
+  quality_score: {{score}}%
+  validation_status: "{{PASS|CONDITIONAL|FAIL}}"
+
+  framework_extraction_ready:
+    principles: {{true|false}}
+    process: {{true|false}}
+    structure: {{true|false}}
+    criteria: {{true|false}}
+    checklist: {{true|false}}
+
+  ready_for_agent_creation: {{true|false}}
+```
+
+---
+
+## Next Steps
+
+Based on this research:
+
+1. **Extract Framework** → Use "Consolidated Framework" section
+2. **Create Agent Definition** → Pre-fill from principles and knowledge areas
+3. **Create Agent Tasks** → Use process, structure, and checklist
+4. **Validate Agent** → Use quality criteria for QA
+
+---
+
+**Document Status:** {{DRAFT|VALIDATED|APPROVED}}
+**Validated By:** {{validator}}
+**Validation Date:** {{validation_date}}
+```
+
+---
+
+## Section Guidelines
+
+### Executive Summary
+
+**Required content:**
+- 2-3 paragraphs overview
+- 3-5 key findings as bullets
+- Framework name identified
+- Source count
+- Confidence assessment
+
+**Quality indicators:**
+- Gives reader clear picture without reading full doc
+- Highlights most important discoveries
+- Honest about confidence/gaps
+
+---
+
+### Scope Sections (1-6)
+
+**Required per section:**
+- Overview paragraph (50+ words)
+- Key findings (3+ bullet points)
+- At least 1 primary evidence block (quote with source)
+- Extracted insights (principles, processes, rules)
+- At least 1 analyzed example
+
+**Quality indicators:**
+- Directly addresses scope point from research prompt
+- Has substantive evidence, not just claims
+- Contains actionable insights
+- Examples are real, not hypothetical
+
+---
+
+### Consolidated Framework
+
+**Principles section:**
+- 3-7 numbered principles
+- Each with quote/citation when possible
+- Explanation of why principle matters
+- Should be memorable and quotable
+
+**Process section:**
+- Complete workflow from start to finish
+- Each step has: name, actions, output
+- Tips and common mistakes per step
+- Should be executable as-is
+
+**Structure section:**
+- Table with all sections/components
+- Purpose and rule per section
+- Detailed guidance for each
+- Examples of good vs bad
+
+**Quality Criteria section:**
+- 5+ "excellent" indicators
+- 5+ "weak" indicators
+- 3+ red flags
+- Based on expert's actual standards
+
+**Checklist section:**
+- Organized by phase (before/during/after)
+- Specific, checkable items
+- Derived from expert criteria
+- Can be used directly in agent tasks
+
+---
+
+### Examples Analyzed
+
+**Per example required:**
+- Clear identification (name, type, date, creator)
+- The actual example or detailed description
+- Line-by-line or element-by-element analysis
+- Connection to principles
+- Key takeaways (3+)
+
+**Quality indicators:**
+- Real examples, not hypothetical
+- Analysis goes beyond surface
+- Explicitly connects to framework
+- Teaches something specific
+
+---
+
+### Modern Adaptation
+
+**Required content:**
+- What principles remain timeless (3+)
+- What needs adaptation (table format)
+- Platform-specific considerations
+
+**Quality indicators:**
+- Honest about what's dated
+- Practical modern equivalents
+- Considers current technology/platforms
+
+---
+
+### Sources
+
+**Required:**
+- All sources cited, organized by tier
+- Primary sources (Tier 1) minimum: 3
+- Each source has: title, author, year, specifics
+
+**Quality indicators:**
+- Primary sources dominate
+- Sources actually support claims
+- Variety of source types
+- No broken/invalid references
+
+---
+
+## Validation Checklist for Template Compliance
+
+- [ ] All required sections present
+- [ ] Executive summary complete (2-3 paragraphs + bullets)
+- [ ] All 6 scope sections have substantive content (50+ lines each)
+- [ ] Consolidated Framework has all 5 sub-sections
+- [ ] At least 3 examples with full analysis
+- [ ] Modern Adaptation section included
+- [ ] Sources properly organized by tier
+- [ ] Research Metadata YAML block complete
+- [ ] Total document >= 500 lines
+
+---
+
+**Template Version:** 1.0.0
+**Created:** 2026-01-22
+**Part of:** squads/squad-chief
+**Validates Against:** checklists/deep-research-quality.md