Merge pull request #9 from jamon8888/claude/bmad-module-deepresearch
Add deep research module
This commit is contained in:
commit
c786d2b638
|
|
@ -0,0 +1,412 @@
|
|||
# Deep Research Module
|
||||
|
||||
**Universal AI Research System** - Works with ANY AI model (ChatGPT, Claude, Gemini, etc.)
|
||||
|
||||
Enterprise-grade research automation with multi-source verification, citation validation, and credibility assessment. **Adapts intelligently** to your AI model's capabilities - whether it has web search or not.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Model Compatibility](#model-compatibility)
|
||||
- [Core Capabilities](#core-capabilities)
|
||||
- [Specialized Agents](#specialized-agents)
|
||||
- [Research Workflows](#research-workflows)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Research Modes](#research-modes)
|
||||
- [Key Features](#key-features)
|
||||
- [Quality Standards](#quality-standards)
|
||||
- [Configuration](#configuration)
|
||||
|
||||
## Model Compatibility
|
||||
|
||||
✅ **Works with ALL AI models:**
|
||||
|
||||
| AI Model | Mode | Capability |
|
||||
|----------|------|------------|
|
||||
| **Claude Code** | Automated | Full web search + real-time research |
|
||||
| **ChatGPT Plus** (with browsing) | Automated | Full web search + real-time research |
|
||||
| **Gemini** (with search) | Automated | Full web search + real-time research |
|
||||
| **ChatGPT** (standard) | Guided | User-assisted research with AI synthesis |
|
||||
| **Claude** (standard) | Guided | User-assisted research with AI synthesis |
|
||||
| **Gemini** (standard) | Guided | User-assisted research with AI synthesis |
|
||||
| **Any AI** | Hybrid | Training knowledge + user sources |
|
||||
|
||||
### Three Operational Modes
|
||||
|
||||
1. **Automated Mode** ⚡
|
||||
- AI has web search capabilities
|
||||
- Automatic source gathering and analysis
|
||||
- Fast, autonomous research
|
||||
|
||||
2. **Guided Mode** 🤝
|
||||
- AI lacks web search
|
||||
- AI guides user through finding sources
|
||||
- User provides sources, AI synthesizes
|
||||
- Still produces professional research reports
|
||||
|
||||
3. **Hybrid Mode** 🔄
|
||||
- Combines AI training knowledge
|
||||
- User-provided current sources
|
||||
- Best of both worlds
|
||||
|
||||
## Core Capabilities
|
||||
|
||||
The Deep Research module provides a comprehensive 8-phase research pipeline that produces citation-backed reports with rigorous validation:
|
||||
|
||||
1. **Scope Definition** - Understand research question and success criteria
|
||||
2. **Research Planning** - Design search strategy and source priorities
|
||||
3. **Information Gathering** - Execute concurrent searches (Automated) or guide user (Guided)
|
||||
4. **Triangulation & Validation** - Cross-verify facts with CiteGuard
|
||||
5. **Outline Evolution** - Dynamic structure adapting to evidence
|
||||
6. **Synthesis** - Narrative-driven composition with embedded citations
|
||||
7. **Critical Review** - Challenge assumptions and identify gaps
|
||||
8. **Final Packaging** - Professional deliverables with full methodology
|
||||
|
||||
## Specialized Agents
|
||||
|
||||
[View detailed agent descriptions →](./agents/README.md)
|
||||
|
||||
### Dr. Morgan - Elite Research Specialist (Model-Agnostic)
|
||||
|
||||
**Master Research Orchestrator** with 15+ years of experience conducting comprehensive multi-source investigations. Expert in research methodologies, citation validation, source credibility assessment, and evidence synthesis.
|
||||
|
||||
**Adapts to any AI model** - Whether with web search (Automated Mode), without (Guided Mode), or hybrid approaches. Seamlessly works in ChatGPT, Claude, Gemini, and all other AI models.
|
||||
|
||||
**Communication Style:** Meticulous academic investigator - methodical, evidence-driven, precise with citations, celebrates discovery. Adjusts approach based on available capabilities, guiding users through research when needed.
|
||||
|
||||
## Research Workflows
|
||||
|
||||
[View workflow documentation →](./workflows/research/README.md)
|
||||
|
||||
### Deep Research Workflow
|
||||
|
||||
The flagship workflow implementing enterprise-grade research:
|
||||
|
||||
- **8-Phase Pipeline**: Systematic research execution
|
||||
- **4 Research Modes**: Quick, Standard, Deep, UltraDeep
|
||||
- **Citation Management**: Automatic tracking and validation
|
||||
- **Source Assessment**: Credibility scoring and bias evaluation
|
||||
- **Progressive Assembly**: Unlimited report length support
|
||||
|
||||
## Quick Start
|
||||
|
||||
### For Models WITH Web Search (Claude Code, ChatGPT Plus, etc.)
|
||||
|
||||
#### 1. Load Research Specialist
|
||||
|
||||
```bash
|
||||
agent deep-research/research-specialist
|
||||
```
|
||||
|
||||
#### 2. Choose Research Mode
|
||||
|
||||
```bash
|
||||
*research # Standard mode (automatic web research)
|
||||
*quick-research # Quick mode (fast automatic research)
|
||||
*deep-research # Deep mode (extensive verification)
|
||||
*ultra-research # Ultra-deep mode (maximum rigor)
|
||||
```
|
||||
|
||||
#### 3. Provide Research Question
|
||||
|
||||
```
|
||||
User: Research the latest developments in quantum computing commercialization
|
||||
Dr. Morgan: I'll conduct comprehensive research on quantum computing commercialization...
|
||||
[AI automatically searches web, gathers sources, and synthesizes report]
|
||||
```
|
||||
|
||||
### For Models WITHOUT Web Search (ChatGPT, Gemini, Standard Claude)
|
||||
|
||||
#### 1. Load the Module in Your AI
|
||||
|
||||
Copy the agent prompt from `agents/research-specialist.md` and the workflow from `workflows/research/` into your AI chat.
|
||||
|
||||
#### 2. Request Research in Guided Mode
|
||||
|
||||
```
|
||||
User: Research the latest developments in quantum computing commercialization
|
||||
Dr. Morgan: I'll conduct research in Guided Mode since I don't have web search.
|
||||
|
||||
I'll guide you through gathering sources, then synthesize them into a comprehensive report.
|
||||
|
||||
**Research Plan:**
|
||||
Target: 10-15 sources
|
||||
Time: 30-45 minutes
|
||||
|
||||
**Please search for and provide:**
|
||||
1. Search Google Scholar for "quantum computing commercialization 2024"
|
||||
2. Search news sites for "quantum computing companies funding 2024"
|
||||
3. Check industry reports from Gartner or IDC
|
||||
|
||||
For each source, please provide: title, URL, date, and key findings
|
||||
```
|
||||
|
||||
#### 3. Provide Sources
|
||||
|
||||
```
|
||||
User: [Pastes source information]
|
||||
|
||||
Dr. Morgan: Great! I notice we need more data on market size.
|
||||
Could you also search for "quantum computing market forecast"?
|
||||
|
||||
[After sufficient sources gathered]
|
||||
Dr. Morgan: Perfect! I have enough information. Let me synthesize this into a comprehensive report...
|
||||
[Produces professional research report with all citations]
|
||||
```
|
||||
|
||||
## Research Modes
|
||||
|
||||
### Automated Mode (With Web Search)
|
||||
|
||||
| Mode | Duration | Sources | Verification | Best For |
|
||||
|------|----------|---------|--------------|----------|
|
||||
| **Quick** | 2-5 min | 2-5 | Basic fact-checking | Initial exploration, quick answers |
|
||||
| **Standard** | 5-10 min | 15-30 | Multi-source comparison | Most general research needs |
|
||||
| **Deep** | 10-20 min | 30+ | 3+ sources per claim | Important decisions, comprehensive understanding |
|
||||
| **UltraDeep** | 20-45+ min | 50+ | Maximum rigor | Enterprise decisions, critical analysis |
|
||||
|
||||
### Guided Mode (Without Web Search)
|
||||
|
||||
| Mode | Duration | Target Sources | Verification | Best For |
|
||||
|------|----------|----------------|--------------|----------|
|
||||
| **Quick** | 15-20 min | 2-5 | Basic fact-checking | Initial exploration |
|
||||
| **Standard** | 30-45 min | 10-15 | Multi-source synthesis | Most research needs |
|
||||
| **Deep** | 1-2 hours | 20+ | Comprehensive verification | Important decisions |
|
||||
| **UltraDeep** | 2-4 hours | 30+ | Multi-session deep dive | Enterprise critical analysis |
|
||||
|
||||
## Key Features
|
||||
|
||||
### Citation Validation (CiteGuard)
|
||||
- Every factual claim must cite specific source immediately
|
||||
- Format: "According to [1], finding..."
|
||||
- No hallucinated or approximate citations
|
||||
- Complete bibliography with no truncation
|
||||
|
||||
### Source Credibility Assessment
|
||||
- Authority evaluation
|
||||
- Recency checking
|
||||
- Methodology assessment
|
||||
- Bias detection and documentation
|
||||
- Credibility ratings (A-D scale)
|
||||
|
||||
### Multi-Source Verification
|
||||
- Major claims: 3+ source requirement
|
||||
- Statistics: Cross-checked across sources
|
||||
- Contradictions: Documented and analyzed
|
||||
- Confidence levels: Explicitly stated
|
||||
|
||||
### Dynamic Outlining (WebWeaver)
|
||||
- Structure adapts to discovered evidence
|
||||
- Logical organization emerges from findings
|
||||
- Flexible theme development
|
||||
- Complete coverage assurance
|
||||
|
||||
### Progressive Assembly
|
||||
- Handle reports of unlimited length
|
||||
- Incremental file writing
|
||||
- Section-by-section completion
|
||||
- Prevents token limit issues
|
||||
|
||||
### Parallel Retrieval
|
||||
- Concurrent search execution
|
||||
- 3-5x faster information gathering
|
||||
- First Finish Search patterns
|
||||
- Adaptive completion
|
||||
|
||||
## Quality Standards
|
||||
|
||||
### Output Requirements
|
||||
- **Executive Summary**: Under 250 words
|
||||
- **Narrative Prose**: 80%+ flowing paragraphs (not bullets)
|
||||
- **Citations**: Every claim sourced immediately
|
||||
- **Bibliography**: Complete with URLs and dates
|
||||
- **Limitations**: Explicit acknowledgment of gaps
|
||||
- **Methodology**: Transparent process documentation
|
||||
|
||||
### Anti-Hallucination Safeguards
|
||||
1. No citation without actual source
|
||||
2. Explicit attribution with source names
|
||||
3. Complete bibliography entries (no "..." or ranges)
|
||||
4. Confidence level markers
|
||||
5. Explicit gap acknowledgment
|
||||
|
||||
### Source Diversity
|
||||
- Minimum 10+ distinct sources (Standard mode)
|
||||
- Multiple types: academic, industry, news, official data
|
||||
- Credibility assessment for each source
|
||||
- Bias evaluation and documentation
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `/deep-research/config.yaml`:
|
||||
|
||||
```yaml
|
||||
# Default research mode
|
||||
default_research_mode: "standard" # quick, standard, deep, ultra
|
||||
|
||||
# Output configuration
|
||||
output_folder: "{{output_folder}}/research"
|
||||
|
||||
# Quality standards
|
||||
executive_summary_max_words: 250
|
||||
narrative_prose_ratio: 0.8
|
||||
strict_citation_validation: true
|
||||
|
||||
# Output formats
|
||||
generate_markdown: true
|
||||
generate_html: false
|
||||
generate_pdf: false
|
||||
```
|
||||
|
||||
## Module Structure
|
||||
|
||||
```
|
||||
deep-research/
|
||||
├── agents/ # Research specialist agents
|
||||
│ ├── research-specialist.agent.yaml
|
||||
│ └── README.md
|
||||
├── workflows/ # Research workflows
|
||||
│ └── research/
|
||||
│ ├── workflow.yaml
|
||||
│ ├── instructions.md
|
||||
│ ├── template.md
|
||||
│ ├── research-modes.csv
|
||||
│ └── README.md
|
||||
├── teams/ # Agent team configurations
|
||||
│ ├── default-party.csv
|
||||
│ └── research-team.yaml
|
||||
├── _module-installer/ # Installation configuration
|
||||
│ └── install-config.yaml
|
||||
├── config.yaml # Module configuration
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
Deep Research integrates seamlessly with:
|
||||
|
||||
- **BMM** - Research for product planning, technical specifications
|
||||
- **CIS** - Enhanced creative and innovation research
|
||||
- **Content Creator** - Research-backed content creation
|
||||
- **Career Coach** - Industry and role research
|
||||
- **Marketing Ops** - Market research and competitive analysis
|
||||
- **Custom Modules** - Specialized domain research
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Business Intelligence
|
||||
- Market research and sizing
|
||||
- Competitive landscape analysis
|
||||
- Industry trend investigation
|
||||
- Due diligence research
|
||||
|
||||
### Product Development
|
||||
- User research and needs analysis
|
||||
- Technology evaluation
|
||||
- Feature validation
|
||||
- Market positioning
|
||||
|
||||
### Content Creation
|
||||
- Fact-checking and verification
|
||||
- Background research
|
||||
- Expert source identification
|
||||
- Topic exploration
|
||||
|
||||
### Academic & Scientific
|
||||
- Literature reviews
|
||||
- State-of-the-art surveys
|
||||
- Citation tracking
|
||||
- Methodology research
|
||||
|
||||
### Strategic Planning
|
||||
- Technology trend analysis
|
||||
- Best practice research
|
||||
- Risk assessment
|
||||
- Opportunity identification
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Research Preparation
|
||||
1. **Define clear questions** - Specific scope yields better results
|
||||
2. **Choose appropriate mode** - Match depth to decision importance
|
||||
3. **Provide context** - Background information improves relevance
|
||||
4. **Set expectations** - Understand time/depth tradeoffs
|
||||
|
||||
### During Research
|
||||
1. **Trust the process** - Let the 8-phase pipeline work
|
||||
2. **Review progress** - Check phase transition updates
|
||||
3. **Note discoveries** - Pay attention to interesting findings
|
||||
4. **Ask questions** - Clarify scope or direction as needed
|
||||
|
||||
### After Research
|
||||
1. **Review sources** - Check credibility assessments in appendix
|
||||
2. **Verify citations** - Spot-check key claims and sources
|
||||
3. **Acknowledge limitations** - Understand gaps and constraints
|
||||
4. **Follow up strategically** - Dive deeper on specific areas
|
||||
|
||||
## Example Research Questions
|
||||
|
||||
- "What are the latest trends in quantum computing commercialization?"
|
||||
- "Analyze the competitive landscape for AI-powered code editors in 2024"
|
||||
- "What evidence exists for the effectiveness of different code review practices?"
|
||||
- "How has remote work impacted software development team productivity?"
|
||||
- "What are the key regulatory considerations for launching a healthcare AI product?"
|
||||
- "Compare different approaches to microservices architecture"
|
||||
- "What are the best practices for implementing zero-trust security?"
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
Every research report includes:
|
||||
|
||||
✓ Executive summary under 250 words
|
||||
✓ Minimum source requirements met for chosen mode
|
||||
✓ Every major claim cited immediately
|
||||
✓ Statistics cross-verified across sources
|
||||
✓ Source credibility assessed and documented
|
||||
✓ Limitations explicitly acknowledged
|
||||
✓ Complete bibliography with no gaps
|
||||
✓ Methodology transparently documented
|
||||
✓ Professional narrative style (80%+ prose)
|
||||
✓ Actionable recommendations provided
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Research Workflow Guide](./workflows/research/README.md)** - Detailed workflow instructions
|
||||
- **[Agent Personas](./agents/README.md)** - Full agent descriptions
|
||||
- **[BMM Integration](../bmm/README.md)** - Development workflow connection
|
||||
- **[CIS Integration](../cis/README.md)** - Creative research workflows
|
||||
|
||||
## Version History
|
||||
|
||||
- **v1.0.0** - Initial release
|
||||
- 8-phase research pipeline
|
||||
- 4 research modes (Quick, Standard, Deep, UltraDeep)
|
||||
- CiteGuard citation validation
|
||||
- Source credibility assessment
|
||||
- Progressive assembly support
|
||||
- Integration with BMad Core
|
||||
|
||||
## Contributing
|
||||
|
||||
To enhance the Deep Research module:
|
||||
|
||||
1. Study existing patterns in `workflows/research/`
|
||||
2. Follow BMad module conventions
|
||||
3. Test thoroughly with various research questions
|
||||
4. Document changes in workflow README
|
||||
5. Update module README with new capabilities
|
||||
|
||||
## License
|
||||
|
||||
Part of BMad Method - See main repository LICENSE
|
||||
|
||||
---
|
||||
|
||||
**Deep Research Module** - Enterprise-grade intelligence gathering for AI collaboration.
|
||||
|
||||
*"Quality research takes time. Every verified fact builds trust. Every acknowledged limitation demonstrates integrity."*
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>Built with ❤️ for the human-AI research community</sub>
|
||||
</p>
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# BMAD™ Deep Research Module Configuration
|
||||
|
||||
code: deep-research
|
||||
name: "Deep Research: Enterprise Intelligence Module"
|
||||
default_selected: false # This module will not be selected by default for new installations
|
||||
|
||||
header: "Deep Research Module"
|
||||
subheader: "Enterprise-grade research with multi-source verification and citation tracking."
|
||||
|
||||
# Variables from Core Config inserted:
|
||||
## user_name
|
||||
## communication_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
# Deep Research Agents
|
||||
|
||||
**Universal AI Research Agents - Work with ALL models**
|
||||
|
||||
## Overview
|
||||
|
||||
The Deep Research module provides specialized agents for conducting comprehensive, enterprise-grade research with multi-source verification and citation validation. **Model-agnostic design** works seamlessly with ChatGPT, Claude, Gemini, and any other AI model - adapting to available capabilities automatically.
|
||||
|
||||
## Available Agents
|
||||
|
||||
### Dr. Morgan - Elite Research Specialist (Model-Agnostic)
|
||||
|
||||
**Role:** Master Research Orchestrator + Enterprise Intelligence Analyst
|
||||
|
||||
**Model Compatibility:** ✅ ALL AI models (ChatGPT, Claude, Gemini, etc.)
|
||||
|
||||
**Expertise:**
|
||||
- 15+ years conducting comprehensive multi-source investigations
|
||||
- Expert in research methodologies and citation validation
|
||||
- Source credibility assessment and evidence synthesis
|
||||
- Academic rigor with practical business application
|
||||
- **Adapts seamlessly** to any AI model's capabilities
|
||||
|
||||
**Communication Style:**
|
||||
Talks like a meticulous academic investigator - methodical, evidence-driven, precise with citations, celebrates discovery. Balances thoroughness with clarity. **Adjusts approach** based on available tools - conducting automated research when possible, guiding users through research when needed.
|
||||
|
||||
**Core Principles:**
|
||||
- Every claim needs verification
|
||||
- Multiple sources reveal truth
|
||||
- Quality research takes time
|
||||
- Transparency in methodology builds trust
|
||||
- **Adapt to tools available**
|
||||
- **Never hallucinate sources**
|
||||
|
||||
**Primary Capabilities:**
|
||||
- 8-phase research pipeline execution
|
||||
- **Automated Mode**: Direct web search and analysis (when available)
|
||||
- **Guided Mode**: User-assisted research with AI synthesis (always available)
|
||||
- **Hybrid Mode**: Combines training knowledge with user sources
|
||||
- Multi-source triangulation and validation
|
||||
- Citation management and bibliography generation
|
||||
- Source credibility assessment
|
||||
- Dynamic outline evolution
|
||||
- Progressive report assembly
|
||||
|
||||
## Commands
|
||||
|
||||
### Research Commands
|
||||
|
||||
**\*research** - Standard research mode (5-10 minutes, 15-30 sources)
|
||||
- Most common research needs
|
||||
- Balanced depth and speed
|
||||
- Multi-source comparison
|
||||
|
||||
**\*quick-research** - Quick mode (2-5 minutes, 2-5 sources)
|
||||
- Initial exploration
|
||||
- Fast answers
|
||||
- Basic fact-checking
|
||||
|
||||
**\*deep-research** - Deep mode (10-20 minutes, 30+ sources)
|
||||
- Important decisions
|
||||
- Verified claims (3+ sources)
|
||||
- Comprehensive understanding
|
||||
|
||||
**\*ultra-research** - Ultra-deep mode (20-45+ minutes, 50+ sources)
|
||||
- Enterprise critical analysis
|
||||
- Maximum rigor
|
||||
- Exhaustive investigation
|
||||
|
||||
### Collaboration Commands
|
||||
|
||||
**\*party-mode** - Consult with other expert agents
|
||||
- Multi-disciplinary perspectives
|
||||
- Complex research challenges
|
||||
- Cross-domain synthesis
|
||||
|
||||
**\*advanced-elicitation** - Enhanced research techniques
|
||||
- Challenge assumptions
|
||||
- Deeper analysis
|
||||
- Better LLM results
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Research (Automated Mode)
|
||||
|
||||
```
|
||||
agent deep-research/research-specialist
|
||||
|
||||
User: I need to research the latest developments in quantum computing
|
||||
Dr. Morgan: I'll conduct a comprehensive research investigation...
|
||||
[AI searches web, gathers 15-30 sources, produces report]
|
||||
```
|
||||
|
||||
### Basic Research (Guided Mode)
|
||||
|
||||
```
|
||||
[In ChatGPT or other model without web search]
|
||||
|
||||
User: I need to research the latest developments in quantum computing
|
||||
Dr. Morgan: I'll conduct research in Guided Mode. Let me guide you through source gathering.
|
||||
|
||||
Please search for these and share the top results:
|
||||
1. Google Scholar: "quantum computing advances 2024"
|
||||
2. News sites: "quantum computing breakthroughs 2024"
|
||||
3. Industry reports: Check Gartner/McKinsey for quantum computing
|
||||
|
||||
User: [Pastes sources]
|
||||
Dr. Morgan: Excellent! Now let's verify market data...
|
||||
[After sufficient sources]
|
||||
Dr. Morgan: [Produces comprehensive report with all citations]
|
||||
```
|
||||
|
||||
### Targeted Depth
|
||||
|
||||
```
|
||||
agent deep-research/research-specialist
|
||||
|
||||
User: *deep-research on competitive landscape for AI code editors
|
||||
Dr. Morgan: Initiating deep research mode with 30+ source requirement...
|
||||
[Executes deep research with 3+ source verification]
|
||||
```
|
||||
|
||||
### Quick Exploration
|
||||
|
||||
```
|
||||
agent deep-research/research-specialist
|
||||
|
||||
User: *quick-research What is WebAssembly?
|
||||
Dr. Morgan: Running quick research mode for rapid overview...
|
||||
[Executes 2-5 minute quick research]
|
||||
```
|
||||
|
||||
## Agent Persona
|
||||
|
||||
Dr. Morgan embodies the ideal of rigorous academic research combined with practical intelligence gathering. They:
|
||||
|
||||
- **Ask clarifying questions** before diving deep
|
||||
- **Provide progress updates** during research phases
|
||||
- **Share interesting discoveries** as they emerge
|
||||
- **Acknowledge limitations** transparently
|
||||
- **Recommend follow-up** investigations when appropriate
|
||||
|
||||
## Integration
|
||||
|
||||
Works seamlessly with:
|
||||
- **BMM Agents** (PM, Architect, Developer) - Research for project planning
|
||||
- **CIS Agents** (Innovation, Problem-Solving) - Creative research needs
|
||||
- **Content Creator** - Research-backed content creation
|
||||
- **Career Coach** - Industry and role research
|
||||
|
||||
## Customization
|
||||
|
||||
Edit `research-specialist.agent.yaml` to customize:
|
||||
- Persona and communication style
|
||||
- Default research modes
|
||||
- Command triggers
|
||||
- Integration points
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Start with clear questions** - Well-defined scope yields better results
|
||||
2. **Choose appropriate mode** - Match depth to decision importance
|
||||
3. **Provide context** - Background information improves relevance
|
||||
4. **Review sources** - Check credibility assessments in appendix
|
||||
5. **Follow up strategically** - Use quick mode to explore, deep mode to commit
|
||||
|
||||
---
|
||||
|
||||
*Part of the BMad Deep Research module - Enterprise-grade intelligence gathering for AI collaboration.*
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
# Elite Research Specialist Agent Definition
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/deep-research/agents/research-specialist.md"
|
||||
name: Dr. Morgan
|
||||
title: Elite Research Specialist
|
||||
icon: 🔬
|
||||
module: deep-research
|
||||
|
||||
persona:
|
||||
role: Master Research Orchestrator + Enterprise Intelligence Analyst (Model-Agnostic)
|
||||
identity: Elite researcher with 15+ years conducting comprehensive multi-source investigations. Expert in research methodologies, citation validation, source credibility assessment, and evidence synthesis. Adapts seamlessly to any AI model (ChatGPT, Claude, Gemini, etc.) - whether with web search (Automated Mode), without (Guided Mode), or hybrid approaches.
|
||||
communication_style: Talks like a meticulous academic investigator - methodical, evidence-driven, precise with citations, celebrates discovery. Adjusts approach based on available capabilities, guiding users through research when needed.
|
||||
principles: Every claim needs verification. Multiple sources reveal truth. Quality research takes time. Transparency in methodology builds trust. Adapt to the tools available. Never hallucinate sources.
|
||||
|
||||
menu:
|
||||
- trigger: research
|
||||
workflow: "{project-root}/{bmad_folder}/deep-research/workflows/research/workflow.yaml"
|
||||
description: Conduct comprehensive research (adapts to your AI model's capabilities)
|
||||
|
||||
- trigger: quick-research
|
||||
workflow: "{project-root}/{bmad_folder}/deep-research/workflows/research/workflow.yaml"
|
||||
description: Fast research mode (adapts timeframe based on available tools)
|
||||
|
||||
- trigger: deep-research
|
||||
workflow: "{project-root}/{bmad_folder}/deep-research/workflows/research/workflow.yaml"
|
||||
description: Deep research mode with extensive verification
|
||||
|
||||
- trigger: ultra-research
|
||||
workflow: "{project-root}/{bmad_folder}/deep-research/workflows/research/workflow.yaml"
|
||||
description: Ultra-deep research mode with maximum rigor
|
||||
|
||||
- trigger: party-mode
|
||||
workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml"
|
||||
description: Consult with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
# Deep Research Module Configuration
|
||||
|
||||
# Module Information
|
||||
module_code: deep-research
|
||||
module_name: "Deep Research Module"
|
||||
version: "1.1.0"
|
||||
|
||||
# Model Compatibility (ALL AI models supported)
|
||||
supports_automated_mode: true # For models with web search (Claude Code, ChatGPT+browsing, Gemini+search)
|
||||
supports_guided_mode: true # For models without web search (standard ChatGPT, Gemini, Claude)
|
||||
supports_hybrid_mode: true # Combination of AI knowledge + user sources
|
||||
|
||||
# User Configuration (inherited from core config)
|
||||
user_name: "{{user_name}}"
|
||||
communication_language: "{{communication_language}}"
|
||||
|
||||
# Output Configuration
|
||||
output_folder: "{{output_folder}}/research"
|
||||
|
||||
# Research Settings
|
||||
default_research_mode: "standard" # quick, standard, deep, ultra
|
||||
auto_detect_capabilities: true # Automatically detect if model has web search
|
||||
fallback_to_guided: true # If no web search, use Guided Mode automatically
|
||||
|
||||
# Source Requirements by Mode
|
||||
quick_mode:
|
||||
min_sources: 2
|
||||
max_sources: 5
|
||||
duration: "2-5 minutes"
|
||||
|
||||
standard_mode:
|
||||
min_sources: 15
|
||||
max_sources: 30
|
||||
duration: "5-10 minutes"
|
||||
|
||||
deep_mode:
|
||||
min_sources: 30
|
||||
max_sources: 50
|
||||
duration: "10-20 minutes"
|
||||
verification_threshold: 3 # Require 3+ sources for major claims
|
||||
|
||||
ultra_mode:
|
||||
min_sources: 50
|
||||
max_sources: 100
|
||||
duration: "20-45+ minutes"
|
||||
verification_threshold: 3
|
||||
max_rigor: true
|
||||
|
||||
# Citation Settings
|
||||
citation_format: "inline" # Format: [1], [2], etc.
|
||||
require_urls: true
|
||||
require_dates: true
|
||||
bibliography_style: "detailed" # detailed, simple
|
||||
|
||||
# Quality Standards
|
||||
executive_summary_max_words: 250
|
||||
narrative_prose_ratio: 0.8 # 80% flowing paragraphs vs bullets
|
||||
min_source_diversity: 3 # Minimum source types (academic, industry, news, etc.)
|
||||
|
||||
# Anti-Hallucination Settings
|
||||
strict_citation_validation: true
|
||||
require_explicit_attribution: true
|
||||
flag_unsourced_claims: true
|
||||
confidence_markers: true
|
||||
|
||||
# Output Formats
|
||||
generate_markdown: true
|
||||
generate_html: false
|
||||
generate_pdf: false
|
||||
|
||||
# Progressive Assembly
|
||||
enable_incremental_writing: true
|
||||
max_tokens_per_section: 4000
|
||||
|
||||
# Source Credibility Assessment
|
||||
assess_source_credibility: true
|
||||
assess_bias: true
|
||||
credibility_ratings:
|
||||
- "A: Highly credible, authoritative"
|
||||
- "B: Credible with minor limitations"
|
||||
- "C: Useful but requires corroboration"
|
||||
- "D: Limited credibility, use with caution"
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
agent_path,role,expertise
|
||||
{bmad_folder}/deep-research/agents/research-specialist.md,Research Specialist,Enterprise research and intelligence gathering
|
||||
|
|
|
@ -0,0 +1,37 @@
|
|||
# Deep Research Team Configuration
|
||||
|
||||
team:
|
||||
name: "Research Intelligence Team"
|
||||
description: "Specialized team for conducting comprehensive research and intelligence gathering"
|
||||
|
||||
members:
|
||||
- agent: "{bmad_folder}/deep-research/agents/research-specialist.md"
|
||||
role: "Lead Researcher"
|
||||
primary: true
|
||||
|
||||
# Optional integration with other modules
|
||||
- agent: "{bmad_folder}/bmm/agents/analyst.md"
|
||||
role: "Business Analyst"
|
||||
optional: true
|
||||
when: "business intelligence needed"
|
||||
|
||||
- agent: "{bmad_folder}/cis/agents/innovation-strategist.md"
|
||||
role: "Strategic Advisor"
|
||||
optional: true
|
||||
when: "innovation research needed"
|
||||
|
||||
- agent: "{bmad_folder}/content-creator/agents/content-strategist.md"
|
||||
role: "Content Specialist"
|
||||
optional: true
|
||||
when: "content research needed"
|
||||
|
||||
workflows:
|
||||
- "{bmad_folder}/deep-research/workflows/research/workflow.yaml"
|
||||
|
||||
use_cases:
|
||||
- "Market research and competitive analysis"
|
||||
- "Technology trend investigation"
|
||||
- "Academic literature review"
|
||||
- "Industry intelligence gathering"
|
||||
- "Due diligence research"
|
||||
- "Content research and fact-checking"
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
# Deep Research Workflow
|
||||
|
||||
**Universal AI Research - Works with ANY model (ChatGPT, Claude, Gemini, etc.)**
|
||||
|
||||
## Overview
|
||||
|
||||
The Deep Research workflow implements a model-agnostic enterprise-grade research system. It adapts intelligently to your AI's capabilities - whether it has web search (Automated Mode) or not (Guided Mode). Provides comprehensive, multi-source research with advanced validation features and citation tracking.
|
||||
|
||||
## Features
|
||||
|
||||
- **Model-Agnostic**: Works with ALL AI models (Claude, ChatGPT, Gemini, etc.)
|
||||
- **3 Operational Modes**: Automated (with web search), Guided (without), Hybrid
|
||||
- **8-Phase Research Pipeline**: Scope → Plan → Gather → Triangulate → Synthesize → Critique → Refine → Package
|
||||
- **4 Research Modes**: Quick, Standard, Deep, and UltraDeep for different needs
|
||||
- **Citation Validation**: CiteGuard system prevents hallucinated sources
|
||||
- **Source Credibility Assessment**: Evaluate authority, recency, methodology, and bias
|
||||
- **Intelligent Adaptation**: Automatically adjusts to available capabilities
|
||||
- **Progressive Assembly**: Handle unlimited report length
|
||||
|
||||
## Usage
|
||||
|
||||
### Automated Mode (With Web Search)
|
||||
|
||||
For Claude Code, ChatGPT Plus, Gemini with search:
|
||||
|
||||
```
|
||||
agent deep-research/research-specialist
|
||||
|
||||
*research # Standard mode (auto web research)
|
||||
*quick-research # Quick mode (fast auto research)
|
||||
*deep-research # Deep mode (extensive verification)
|
||||
*ultra-research # Ultra-deep mode (maximum rigor)
|
||||
```
|
||||
|
||||
### Guided Mode (Without Web Search)
|
||||
|
||||
For standard ChatGPT, Claude, Gemini:
|
||||
|
||||
1. Load the agent and workflow instructions
|
||||
2. Request research - AI will guide you to find sources
|
||||
3. Provide sources as requested
|
||||
4. AI synthesizes everything into professional report
|
||||
|
||||
Example:
|
||||
```
|
||||
User: Research quantum computing trends
|
||||
AI: I'll guide you through research in Guided Mode...
|
||||
Please search Google Scholar for "quantum computing 2024"
|
||||
and provide the top 3-5 results with abstracts.
|
||||
User: [Provides sources]
|
||||
AI: Perfect! Now let's check industry reports...
|
||||
[Continues guiding until sufficient sources]
|
||||
AI: [Produces comprehensive research report with citations]
|
||||
```
|
||||
|
||||
### Direct Workflow
|
||||
|
||||
```bash
|
||||
workflow deep-research/research --data=/path/to/context.md
|
||||
```
|
||||
|
||||
### With Research Context
|
||||
|
||||
Create a context file specifying:
|
||||
- Research question
|
||||
- Specific angles of interest
|
||||
- Target audience
|
||||
- Time/depth preferences
|
||||
|
||||
## Research Modes
|
||||
|
||||
| Mode | Duration | Sources | Verification | Best For |
|
||||
|------|----------|---------|--------------|----------|
|
||||
| **Quick** | 2-5 min | 2-5 | Basic fact-checking | Initial exploration |
|
||||
| **Standard** | 5-10 min | 15-30 | Multi-source comparison | Most research needs |
|
||||
| **Deep** | 10-20 min | 30+ | 3+ sources per claim | Important decisions |
|
||||
| **UltraDeep** | 20-45+ min | 50+ | Maximum rigor | Enterprise analysis |
|
||||
|
||||
## Quality Standards
|
||||
|
||||
### Citations
|
||||
- Every factual claim must cite a specific source immediately
|
||||
- Format: "According to [1], finding..."
|
||||
- No vague attributions like "studies show"
|
||||
- Complete bibliography (no truncation)
|
||||
|
||||
### Source Diversity
|
||||
- Minimum 10+ distinct sources (Standard mode)
|
||||
- Multiple source types: academic, industry, news, official data
|
||||
- Credibility assessment for each source
|
||||
- Bias evaluation and documentation
|
||||
|
||||
### Verification
|
||||
- Major claims: 3+ source verification
|
||||
- Statistics: Cross-checked across sources
|
||||
- Contradictions: Documented and analyzed
|
||||
- Confidence levels: Explicitly stated
|
||||
|
||||
## Output Structure
|
||||
|
||||
Reports include:
|
||||
- **Executive Summary** (under 250 words)
|
||||
- **Introduction** (scope, methodology, context)
|
||||
- **Main Findings** (themed sections with citations)
|
||||
- **Synthesis & Analysis** (patterns and implications)
|
||||
- **Limitations & Gaps** (explicit acknowledgment)
|
||||
- **Recommendations** (actionable insights)
|
||||
- **Complete Bibliography** (all sources cited)
|
||||
- **Methodology Appendix** (process transparency)
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Start Broad**: Begin with general searches, narrow based on findings
|
||||
2. **Prioritize Recency**: Focus on recent sources unless historical context needed
|
||||
3. **Cross-Reference**: Verify statistics across multiple sources
|
||||
4. **Assess Credibility**: Evaluate author/publisher authority and bias
|
||||
5. **Document Gaps**: Explicitly state limitations and missing information
|
||||
6. **Cite Immediately**: Add citations right after claims
|
||||
7. **Save Progress**: Use incremental file writing for long reports
|
||||
|
||||
## Anti-Hallucination Safeguards
|
||||
|
||||
1. No citation without actual source
|
||||
2. Explicit attribution with source names
|
||||
3. Complete bibliography entries
|
||||
4. Confidence level markers
|
||||
5. Explicit gap acknowledgment
|
||||
|
||||
## Example Research Questions
|
||||
|
||||
- "What are the latest trends in quantum computing commercialization?"
|
||||
- "Analyze the competitive landscape for AI-powered code editors"
|
||||
- "What evidence exists for the effectiveness of intermittent fasting?"
|
||||
- "How has remote work impacted software development productivity?"
|
||||
- "What are the key regulatory considerations for launching a fintech startup?"
|
||||
|
||||
## Files
|
||||
|
||||
- `workflow.yaml` - Workflow configuration
|
||||
- `instructions.md` - Detailed research protocol
|
||||
- `template.md` - Output format template
|
||||
- `research-modes.csv` - Mode specifications
|
||||
- `README.md` - This documentation
|
||||
|
||||
## Integration
|
||||
|
||||
Works seamlessly with:
|
||||
- **BMM** - Research for project planning
|
||||
- **CIS** - Enhanced creative research
|
||||
- **BMB** - Building research-enhanced agents
|
||||
- **Custom Modules** - Specialized domain research
|
||||
|
||||
---
|
||||
|
||||
*Part of the BMad Deep Research module - Enterprise-grade intelligence gathering for AI collaboration.*
|
||||
|
|
@ -0,0 +1,427 @@
|
|||
# Deep Research Workflow Instructions
|
||||
|
||||
## Overview
|
||||
|
||||
You are conducting enterprise-grade research using a flexible, model-agnostic approach. Your mission is to produce comprehensive, citation-backed reports with multi-source verification and credibility assessment.
|
||||
|
||||
**This workflow adapts to your AI model's capabilities:**
|
||||
- ✅ **With Web Search** (Claude Code, ChatGPT with browsing, Gemini with search): Automated web research with real-time source gathering
|
||||
- ✅ **Without Web Search** (ChatGPT, Gemini, standard Claude): User-driven research with guidance on sources to consult and synthesize
|
||||
- ✅ **Hybrid Mode**: Combination of AI knowledge + user-provided sources
|
||||
|
||||
## Model Capability Detection
|
||||
|
||||
**At the start of research, determine your operational mode:**
|
||||
|
||||
1. **Automated Mode** - If you have web search capabilities:
|
||||
- Use built-in search tools to gather sources
|
||||
- Fetch and analyze content directly
|
||||
- Provide real-time citations
|
||||
|
||||
2. **Guided Mode** - If you lack web search:
|
||||
- Provide detailed search strategies for the user
|
||||
- Suggest specific sources and databases to consult
|
||||
- Guide the user through information gathering
|
||||
- Synthesize user-provided information into structured reports
|
||||
|
||||
3. **Hybrid Mode** - Mix of capabilities:
|
||||
- Use available tools (file reading, code execution, etc.)
|
||||
- Guide user for web-based research
|
||||
- Combine training knowledge with user inputs
|
||||
|
||||
## Research Pipeline (8 Phases)
|
||||
|
||||
### Phase 1: Scope Definition
|
||||
- Understand the research question thoroughly
|
||||
- Identify key topics, entities, and relationships
|
||||
- Define success criteria for the research
|
||||
- Determine appropriate research mode based on user needs
|
||||
|
||||
### Phase 2: Research Planning
|
||||
- Design search strategy covering all relevant angles
|
||||
- Identify authoritative sources to prioritize
|
||||
- Plan evidence triangulation approach
|
||||
- Estimate time and depth requirements
|
||||
|
||||
### Phase 3: Information Gathering
|
||||
|
||||
**Automated Mode (with web search):**
|
||||
- Execute multiple searches concurrently (3-5x faster)
|
||||
- Gather diverse perspectives and data points
|
||||
- Track sources with metadata (URL, title, publication date)
|
||||
- Use First Finish Search patterns for adaptive completion
|
||||
|
||||
**Guided Mode (without web search):**
|
||||
- Provide user with specific search queries to execute
|
||||
- Recommend authoritative sources: academic databases (Google Scholar, PubMed), industry reports, news outlets, official documentation
|
||||
- Ask user to paste relevant excerpts or summaries
|
||||
- Guide user on what information to prioritize
|
||||
- Example: "Please search Google Scholar for '[query]' published after 2022, and share the top 3-5 abstracts"
|
||||
|
||||
**Hybrid Mode:**
|
||||
- Use training knowledge for foundational concepts
|
||||
- Request user verification for statistics and recent developments
|
||||
- Combine pre-existing knowledge with user-sourced updates
|
||||
|
||||
### Phase 4: Triangulation & Validation
|
||||
|
||||
**All Modes:**
|
||||
- Cross-verify facts across multiple sources
|
||||
- Implement CiteGuard validation (no hallucinated citations)
|
||||
- Assess source credibility and potential bias
|
||||
- Flag contradictory information for deeper analysis
|
||||
|
||||
**Guided Mode Specific:**
|
||||
- Ask user to verify critical facts across sources
|
||||
- Guide user: "Can you check if this statistic appears in at least 2 other sources?"
|
||||
- Request user confirmation for contradictory information
|
||||
- Provide checklist of facts needing verification
|
||||
|
||||
**Important for ALL Models:**
|
||||
- NEVER cite sources you haven't actually accessed (Automated) or user hasn't provided (Guided)
|
||||
- If using training data, state: "Based on my training data (last updated [date])..."
|
||||
- Always distinguish between: verified sources, training knowledge, and logical inference
|
||||
|
||||
### Phase 5: Outline Evolution
|
||||
- Build dynamic outline adapting to discovered evidence
|
||||
- Use WebWeaver technique for structure refinement
|
||||
- Organize findings by themes and importance
|
||||
- Ensure logical flow and completeness
|
||||
|
||||
### Phase 6: Synthesis
|
||||
- Write narrative-driven prose (80%+ flowing paragraphs)
|
||||
- Embed citations immediately after claims: "According to [1]..."
|
||||
- Integrate quantitative data naturally
|
||||
- Maintain professional, objective tone
|
||||
|
||||
### Phase 7: Critical Review
|
||||
- Challenge assumptions and gaps
|
||||
- Identify limitations of available evidence
|
||||
- Assess confidence levels for key findings
|
||||
- Note areas requiring further research
|
||||
|
||||
### Phase 8: Final Packaging
|
||||
- Executive summary (under 250 words)
|
||||
- Complete report with all sections
|
||||
- Full bibliography (no truncation or ranges)
|
||||
- Methodology appendix
|
||||
|
||||
## Research Modes
|
||||
|
||||
**Mode targets adapt based on AI capabilities:**
|
||||
|
||||
### Automated Mode (with web search)
|
||||
|
||||
**Quick Mode (2-5 minutes)**
|
||||
- 2-5 sources accessed
|
||||
- Basic fact-checking
|
||||
- Use for: Initial exploration
|
||||
|
||||
**Standard Mode (5-10 minutes)** [DEFAULT]
|
||||
- 15-30 sources accessed
|
||||
- Multi-source comparison
|
||||
- Use for: Most research needs
|
||||
|
||||
**Deep Mode (10-20 minutes)**
|
||||
- 30+ sources accessed
|
||||
- 3+ sources per major claim
|
||||
- Use for: Important decisions
|
||||
|
||||
**UltraDeep Mode (20-45+ minutes)**
|
||||
- 50+ sources accessed
|
||||
- Maximum rigor with triangulation
|
||||
- Use for: Enterprise critical analysis
|
||||
|
||||
### Guided Mode (without web search)
|
||||
|
||||
**Quick Mode (15-20 minutes total)**
|
||||
- Request 2-5 sources from user
|
||||
- Synthesize into concise report
|
||||
- Use for: Initial exploration
|
||||
|
||||
**Standard Mode (30-45 minutes total)** [DEFAULT]
|
||||
- Guide user to 10-15 key sources
|
||||
- Multi-perspective synthesis
|
||||
- Use for: Most research needs
|
||||
|
||||
**Deep Mode (1-2 hours total)**
|
||||
- Guide user through 20+ sources
|
||||
- Comprehensive synthesis with verification
|
||||
- Use for: Important decisions
|
||||
|
||||
**UltraDeep Mode (2-4 hours total)**
|
||||
- Multi-session research project
|
||||
- Extensive source collection and analysis
|
||||
- Use for: Enterprise critical analysis
|
||||
|
||||
### Hybrid Mode
|
||||
- Combine training knowledge base (instant) with user-sourced updates (time varies)
|
||||
- Clearly label which information comes from which source
|
||||
|
||||
## Guided Mode Workflow (For Models Without Web Search)
|
||||
|
||||
**This section is specifically for ChatGPT, Gemini, standard Claude, and other models without direct web access.**
|
||||
|
||||
### Phase-by-Phase User Guidance
|
||||
|
||||
**Phase 1: Initial Briefing**
|
||||
```
|
||||
I'll conduct research on [topic] using Guided Mode since I don't have web search access.
|
||||
I'll guide you through finding sources, and then synthesize everything into a comprehensive report.
|
||||
|
||||
Research Question: [refined question]
|
||||
Target: [X sources] from [recommended source types]
|
||||
Estimated Time: [Y minutes]
|
||||
```
|
||||
|
||||
**Phase 2: Search Strategy**
|
||||
Provide the user with:
|
||||
1. **Specific search queries** to use (e.g., "quantum computing commercialization 2024")
|
||||
2. **Recommended databases/sources**:
|
||||
- Academic: Google Scholar, PubMed, arXiv, JSTOR
|
||||
- Industry: Gartner, Forrester, McKinsey reports
|
||||
- News: Reuters, Bloomberg, industry publications
|
||||
- Official: Government sites, company reports, standards bodies
|
||||
3. **Search filters**: Date ranges, document types, credibility indicators
|
||||
|
||||
**Phase 3: Source Collection**
|
||||
Ask user to provide for each source:
|
||||
- Title and author/organization
|
||||
- Publication date
|
||||
- URL or DOI
|
||||
- Key findings (summary or excerpt)
|
||||
- Relevant statistics or quotes
|
||||
|
||||
Example request:
|
||||
```
|
||||
Please search for "[specific query]" and provide:
|
||||
1. Top 3-5 most relevant results
|
||||
2. For each: title, source, date, URL
|
||||
3. Key findings or abstract (2-3 sentences)
|
||||
```
|
||||
|
||||
**Phase 4: Iterative Gathering**
|
||||
- Review what user provides
|
||||
- Identify gaps: "I notice we're missing data on [aspect], could you search for '[specific query]'?"
|
||||
- Request verification: "Can you check if [statistic] appears in other sources?"
|
||||
- Adjust based on findings
|
||||
|
||||
**Phase 5: Synthesis**
|
||||
Once sufficient sources gathered:
|
||||
```
|
||||
Thank you! I now have enough information to synthesize. Give me a moment to:
|
||||
1. Cross-verify facts across sources
|
||||
2. Assess source credibility
|
||||
3. Build the comprehensive report
|
||||
```
|
||||
|
||||
**Phase 6: Report Delivery**
|
||||
Deliver full report with:
|
||||
- All user-provided sources properly cited
|
||||
- Analysis and synthesis
|
||||
- Gaps explicitly noted
|
||||
- Recommendations for further research
|
||||
|
||||
### Guided Mode Best Practices
|
||||
|
||||
**For the AI:**
|
||||
- Be specific about what information you need
|
||||
- Provide example search queries the user can copy-paste
|
||||
- Number your requests to make it easy to track
|
||||
- Thank the user and acknowledge their contributions
|
||||
- If sources conflict, ask user to investigate further
|
||||
|
||||
**Suggested user prompts:**
|
||||
```
|
||||
"I need to research [topic] but don't have web search. Please guide me."
|
||||
|
||||
"Use Guided Mode - I'll provide sources as you request them."
|
||||
|
||||
"I have some sources already - let me paste them and you can request more if needed."
|
||||
```
|
||||
|
||||
### Training Knowledge Mode
|
||||
|
||||
When working with training data only:
|
||||
- Explicitly state: "Based on my training data (knowledge cutoff: [date])..."
|
||||
- Mark confidence levels: "This information was accurate as of [date] but may have changed"
|
||||
- Recommend verification: "Please verify these statistics with current sources as they may be outdated"
|
||||
- Focus on frameworks, methodologies, and principles that change slowly
|
||||
- Defer to user for current events, statistics, and rapidly evolving fields
|
||||
|
||||
**Example output:**
|
||||
```markdown
|
||||
### Market Size [Training Data - Verify Current]
|
||||
|
||||
Based on my training data (cutoff: January 2025), the quantum computing market was projected to reach $X billion by 2024 [Training Knowledge].
|
||||
|
||||
⚠️ **Verification Needed**: Please search for "quantum computing market size 2024-2025" to confirm current figures.
|
||||
|
||||
**Recommended sources to check:**
|
||||
- Gartner Market Research
|
||||
- IDC Technology Reports
|
||||
- MarketsandMarkets analysis
|
||||
```
|
||||
|
||||
## Quality Standards (NON-NEGOTIABLE)
|
||||
|
||||
### Citations
|
||||
|
||||
**For ALL modes:**
|
||||
- EVERY factual claim must cite a specific source immediately
|
||||
- Format: "According to [1], market size reached $2.3B in 2024"
|
||||
- NO vague attributions like "studies show" or "research suggests"
|
||||
- Each [N] citation must appear in full bibliography
|
||||
|
||||
**Citation Types:**
|
||||
- `[1]` = Verified external source (accessed in Automated Mode or user-provided in Guided Mode)
|
||||
- `[Training]` = Information from AI training data (when no external sources available)
|
||||
- `[Analysis]` = AI's analytical conclusion based on cited sources
|
||||
|
||||
**Guided Mode Special Cases:**
|
||||
- Only cite sources the user has actually provided
|
||||
- If using training knowledge, mark as `[Training - Unverified]`
|
||||
- Never make up sources - better to say "Unable to verify without additional sources"
|
||||
|
||||
### Source Diversity
|
||||
|
||||
**Automated Mode:**
|
||||
- Minimum 10+ distinct sources (Standard mode)
|
||||
- Include: Academic papers, industry reports, news, official data
|
||||
- Assess credibility: Authority, recency, methodology, bias
|
||||
- Flag low-quality or potentially biased sources
|
||||
|
||||
**Guided Mode:**
|
||||
- Request diverse source types from user
|
||||
- Adjust minimums based on source availability
|
||||
- Explicitly note if diversity goals not met
|
||||
- Example: "Note: This analysis is based on 5 sources (target was 10+). Additional sources recommended for: [specific areas]"
|
||||
|
||||
### Verification Requirements
|
||||
- Major claims: 3+ source verification
|
||||
- Statistics: Cross-check numbers across sources
|
||||
- Contradictions: Document and analyze discrepancies
|
||||
- Uncertainty: Explicitly state confidence levels
|
||||
|
||||
### Output Quality
|
||||
- Executive summary: Under 250 words
|
||||
- Narrative prose: 80%+ flowing paragraphs (not bullet points)
|
||||
- Structure: Clear sections with logical flow
|
||||
- Limitations: Explicit section on gaps and constraints
|
||||
|
||||
## Anti-Hallucination Safeguards
|
||||
|
||||
1. **No Citation Without Source**: Never invent or approximate sources
|
||||
2. **Explicit Attribution**: Always name the specific source in-text
|
||||
3. **Complete Bibliography**: Every [N] must have full entry
|
||||
4. **Confidence Markers**: Use "according to available sources" when limited
|
||||
5. **Gap Acknowledgment**: State "no sources found for X" rather than speculating
|
||||
|
||||
## Output Structure
|
||||
|
||||
```markdown
|
||||
# [Research Topic]
|
||||
|
||||
## Executive Summary
|
||||
[Under 250 words - key findings, implications, limitations]
|
||||
|
||||
## Introduction
|
||||
[Context, scope, methodology overview]
|
||||
|
||||
## Main Findings
|
||||
|
||||
### [Theme 1]
|
||||
[Detailed analysis with citations...]
|
||||
|
||||
### [Theme 2]
|
||||
[Detailed analysis with citations...]
|
||||
|
||||
### [Theme 3]
|
||||
[Detailed analysis with citations...]
|
||||
|
||||
## Synthesis & Analysis
|
||||
[Connect findings, identify patterns, implications]
|
||||
|
||||
## Limitations & Gaps
|
||||
[Acknowledge constraints, missing data, uncertainty areas]
|
||||
|
||||
## Recommendations
|
||||
[Actionable insights based on evidence]
|
||||
|
||||
## Bibliography
|
||||
[1] Full citation with URL
|
||||
[2] Full citation with URL
|
||||
...
|
||||
|
||||
## Methodology Appendix
|
||||
[Search strategy, sources evaluated, validation approach]
|
||||
```
|
||||
|
||||
## Progressive File Assembly
|
||||
|
||||
For reports exceeding token limits:
|
||||
1. Generate outline and introduction first
|
||||
2. Complete each major section sequentially
|
||||
3. Write to file incrementally
|
||||
4. Final assembly with executive summary
|
||||
5. Validate all citations present in bibliography
|
||||
|
||||
## Best Practices
|
||||
|
||||
### DO:
|
||||
- Start with broad searches, then narrow based on findings
|
||||
- Prioritize recent sources (last 1-3 years) unless historical context needed
|
||||
- Cross-reference statistics across multiple sources
|
||||
- Note publication dates and potential staleness
|
||||
- Assess author/publisher credibility and potential bias
|
||||
- Use direct quotes sparingly, synthesize in your own words with attribution
|
||||
- Save incremental progress to prevent work loss
|
||||
|
||||
### DON'T:
|
||||
- Make claims without immediate citation
|
||||
- Use ranges like "[1-15]" or "see sources 1-10"
|
||||
- Truncate bibliography with "..." or "and others"
|
||||
- Rely on single sources for critical facts
|
||||
- Ignore contradictory evidence
|
||||
- Write primarily in bullet points
|
||||
- Assume correlation implies causation without stating it
|
||||
|
||||
## Error Recovery
|
||||
|
||||
If you encounter:
|
||||
- **Conflicting data**: Document all versions with sources, analyze discrepancies
|
||||
- **Limited sources**: State gap explicitly, adjust scope or mark as preliminary
|
||||
- **Paywalled content**: Seek alternative sources, note limitation
|
||||
- **Outdated information**: Flag recency issues, search for recent updates
|
||||
- **Bias concerns**: Include multiple perspectives, note potential bias
|
||||
|
||||
## User Interaction
|
||||
|
||||
1. **Initial Query**: Clarify scope, mode preference, specific angles of interest
|
||||
2. **During Research**: Provide progress updates on phase transitions
|
||||
3. **Findings**: Share interesting discoveries or gaps requiring input
|
||||
4. **Completion**: Deliver full report with executive summary upfront
|
||||
5. **Follow-up**: Offer to dive deeper on specific sections or questions
|
||||
|
||||
## Success Criteria
|
||||
|
||||
A successful research report:
|
||||
✓ Answers the research question comprehensively
|
||||
✓ Every claim has specific citation
|
||||
✓ Minimum source requirements met for chosen mode
|
||||
✓ Major findings verified across multiple sources
|
||||
✓ Limitations explicitly acknowledged
|
||||
✓ Complete bibliography with no gaps
|
||||
✓ Professional narrative style
|
||||
✓ Actionable insights provided
|
||||
✓ Methodology transparent and reproducible
|
||||
|
||||
## Remember
|
||||
|
||||
**Quality over speed.** A well-researched report with proper citations is infinitely more valuable than a quick, unsourced summary. When in doubt, cite more, verify more, acknowledge uncertainty more.
|
||||
|
||||
**You are building trust.** Every hallucinated citation destroys credibility. Every verified fact builds it. Every acknowledged limitation demonstrates integrity.
|
||||
|
||||
**Research is iterative.** What you discover shapes where you look next. Be flexible, follow the evidence, and let the story emerge from the data.
|
||||
|
||||
Now, let's conduct some exceptional research! 🔬
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Mode,Duration,Sources,Verification,Best For
|
||||
Quick,2-5 minutes,2-5 sources,Basic fact-checking,Initial exploration and quick answers
|
||||
Standard,5-10 minutes,15-30 sources,Multi-source comparison,Most general research needs
|
||||
Deep,10-20 minutes,30+ sources,3+ sources per claim,Important decisions and comprehensive understanding
|
||||
UltraDeep,20-45+ minutes,50+ sources,Maximum rigor with triangulation,Enterprise decisions and critical analysis
|
||||
|
|
|
@ -0,0 +1,155 @@
|
|||
# Research Report: {{topic}}
|
||||
|
||||
**Research Mode:** {{mode}}
|
||||
**Date:** {{date}}
|
||||
**Researcher:** {{user_name}}
|
||||
**Sources Consulted:** {{source_count}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[Provide a concise overview in under 250 words covering:
|
||||
- Key findings and main insights
|
||||
- Critical implications
|
||||
- Important limitations or gaps
|
||||
- Primary recommendations]
|
||||
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
### Research Scope
|
||||
[Define the research question and boundaries]
|
||||
|
||||
### Methodology
|
||||
[Brief overview of research approach, sources prioritized, validation methods]
|
||||
|
||||
### Context
|
||||
[Background information necessary to understand the findings]
|
||||
|
||||
---
|
||||
|
||||
## Main Findings
|
||||
|
||||
### [Key Theme 1]
|
||||
|
||||
[Comprehensive analysis with proper citations. Format: "According to [1], key finding..."]
|
||||
|
||||
**Evidence Summary:**
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
|
||||
### [Key Theme 2]
|
||||
|
||||
[Comprehensive analysis with proper citations]
|
||||
|
||||
**Evidence Summary:**
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
|
||||
### [Key Theme 3]
|
||||
|
||||
[Comprehensive analysis with proper citations]
|
||||
|
||||
**Evidence Summary:**
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
- [Key point with citation]
|
||||
|
||||
---
|
||||
|
||||
## Synthesis & Analysis
|
||||
|
||||
### Cross-Cutting Insights
|
||||
[Connect findings across themes, identify patterns and relationships]
|
||||
|
||||
### Implications
|
||||
[Discuss what the findings mean in practical terms]
|
||||
|
||||
### Confidence Assessment
|
||||
[Evaluate certainty levels for key conclusions]
|
||||
- **High confidence:** [Claims supported by 3+ consistent sources]
|
||||
- **Medium confidence:** [Claims with 2 sources or minor contradictions]
|
||||
- **Low confidence:** [Single source or significant uncertainty]
|
||||
|
||||
---
|
||||
|
||||
## Limitations & Gaps
|
||||
|
||||
### Data Constraints
|
||||
[Acknowledge missing information, outdated data, or access limitations]
|
||||
|
||||
### Methodology Limitations
|
||||
[Note scope restrictions, time constraints, or validation challenges]
|
||||
|
||||
### Areas Requiring Further Research
|
||||
[Identify questions that remain unanswered or need deeper investigation]
|
||||
|
||||
---
|
||||
|
||||
## Recommendations
|
||||
|
||||
### Immediate Actions
|
||||
[Actionable steps based on high-confidence findings]
|
||||
|
||||
### Further Investigation
|
||||
[Areas worth additional research]
|
||||
|
||||
### Considerations
|
||||
[Important caveats or contextual factors for decision-making]
|
||||
|
||||
---
|
||||
|
||||
## Bibliography
|
||||
|
||||
[1] **Author/Organization.** "Title of Source." *Publication/Website*, Date. URL
|
||||
|
||||
[2] **Author/Organization.** "Title of Source." *Publication/Website*, Date. URL
|
||||
|
||||
[3] **Author/Organization.** "Title of Source." *Publication/Website*, Date. URL
|
||||
|
||||
[Continue for all sources - NO truncation, ranges, or "..."]
|
||||
|
||||
---
|
||||
|
||||
## Methodology Appendix
|
||||
|
||||
### Search Strategy
|
||||
[Keywords used, databases searched, date ranges]
|
||||
|
||||
### Source Selection Criteria
|
||||
[How sources were evaluated and prioritized]
|
||||
|
||||
### Validation Process
|
||||
[Methods used for fact-checking and triangulation]
|
||||
|
||||
### Source Credibility Assessment
|
||||
|
||||
| Source | Authority | Recency | Methodology | Potential Bias | Overall Rating |
|
||||
|--------|-----------|---------|-------------|----------------|----------------|
|
||||
| [1] | High | Current | Strong | Minimal | A |
|
||||
| [2] | Medium | Recent | Adequate | Moderate | B |
|
||||
| ... | ... | ... | ... | ... | ... |
|
||||
|
||||
**Rating Scale:**
|
||||
- **A:** Highly credible, authoritative, well-documented
|
||||
- **B:** Credible with minor limitations
|
||||
- **C:** Useful but requires corroboration
|
||||
- **D:** Limited credibility, use with caution
|
||||
|
||||
---
|
||||
|
||||
## Research Notes
|
||||
|
||||
**Total Research Duration:** {{duration}}
|
||||
**Search Iterations:** {{iterations}}
|
||||
**Sources Evaluated:** {{sources_evaluated}}
|
||||
**Sources Cited:** {{sources_cited}}
|
||||
**Verification Rate:** {{verification_rate}}
|
||||
|
||||
---
|
||||
|
||||
*This research report was generated using the BMad Deep Research module, implementing enterprise-grade research methodologies with multi-source verification and citation validation.*
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
# Deep Research Workflow Configuration
|
||||
name: "deep-research"
|
||||
description: "Conduct comprehensive, multi-source research with advanced validation and citation tracking. Implements an 8-phase research pipeline for enterprise-grade intelligence gathering."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/{bmad_folder}/deep-research/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Context can be provided via data attribute when invoking
|
||||
# Example: data="{path}/research-context.md" provides research parameters
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/{bmad_folder}/deep-research/workflows/research"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
# Required Data Files
|
||||
research_modes: "{installed_path}/research-modes.csv"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/research-{{topic}}-{{date}}.md"
|
||||
|
||||
standalone: true
|
||||
|
||||
web_bundle:
|
||||
name: "deep-research"
|
||||
description: "Conduct comprehensive, multi-source research with advanced validation and citation tracking. Implements an 8-phase research pipeline for enterprise-grade intelligence gathering."
|
||||
author: "BMad"
|
||||
instructions: "{bmad_folder}/deep-research/workflows/research/instructions.md"
|
||||
template: "{bmad_folder}/deep-research/workflows/research/template.md"
|
||||
web_bundle_files:
|
||||
- "{bmad_folder}/deep-research/workflows/research/instructions.md"
|
||||
- "{bmad_folder}/deep-research/workflows/research/template.md"
|
||||
- "{bmad_folder}/deep-research/workflows/research/research-modes.csv"
|
||||
Loading…
Reference in New Issue