ai-qakit 1.0.0

package/templates/.claude/commands/devkit/research.md

@@ -0,0 +1,394 @@
+---
+description: Deep research with documentation discovery and report generation
+argument-hint: [topic] | [technology] | [question]
+allowed-tools: Read, Write, Grep, Bash, Task, WebSearch, WebFetch, AskUserQuestion, Skill
+---
+
+<!--
+Usage: /research [topic]
+Example: /research "Next.js 14 server components best practices"
+Example: /research "PostgreSQL vs MongoDB for real-time analytics"
+Example: /research "How to implement OAuth 2.1 with PKCE"
+-->
+
+# Deep Research - Multi-Source Technical Investigation
+
+**Report Protocol**: Follow CLAUDE.md "Sub-Agent Report Generation" protocol before spawning researcher subagents.
+
+Orchestrates comprehensive research with documentation discovery.
+
+## Agents Used
+- **researcher** - Expert research specialist with systematic methodology
+
+## Skills Applied
+- **research** - Systematic information gathering and analysis
+- **docs-seeker** - Documentation discovery via scripts
+- **sequential-thinking** - Structured analysis
+
+---
+
+## Phase 1: Research Scope
+
+### Define Research Goal
+
+If $ARGUMENTS provided, use it. Otherwise:
+
+```
+Question: What should I research?
+Header: Research Topic
+Options:
+  - Technology/library evaluation
+  - Best practices for [topic]
+  - How to implement [feature]
+  - Compare [A] vs [B]
+  - Security considerations for [topic]
+  - Performance optimization for [topic]
+  - I'll describe the research need
+```
+
+### Scope Definition
+
+```
+════════════════════════════════════════════════════════════════════
+                    🔬 RESEARCH SCOPE
+════════════════════════════════════════════════════════════════════
+
+TOPIC: [research topic]
+
+RESEARCH QUESTIONS:
+  1. [Primary question]
+  2. [Secondary question]
+  3. [Secondary question]
+
+DEPTH: [Overview / Deep Dive / Comprehensive]
+
+RECENCY: [Last 6 months / Last year / Any]
+
+OUTPUT FORMAT:
+  □ Executive summary
+  □ Detailed report
+  □ Comparison table
+  □ Implementation guide
+  □ Best practices checklist
+
+════════════════════════════════════════════════════════════════════
+```
+
+---
+
+## Phase 2: Documentation Discovery
+
+**Apply:** `docs-seeker` skill
+
+### Find Official Documentation
+
+```bash
+# Use docs-seeker scripts if available
+node .claude/skills/docs-seeker/scripts/detect-topic.js "[topic]" 2>/dev/null
+
+# Fetch documentation
+node .claude/skills/docs-seeker/scripts/fetch-docs.js "[topic]" 2>/dev/null
+```
+
+### Source Identification
+
+```
+DOCUMENTATION SOURCES:
+
+OFFICIAL DOCS:
+  □ [URL 1] - Official documentation
+  □ [URL 2] - API reference
+  □ [URL 3] - Getting started guide
+
+GITHUB REPOSITORIES:
+  □ [repo 1] - Main repository
+  □ [repo 2] - Examples/samples
+
+COMMUNITY RESOURCES:
+  □ [URL] - Popular blog post
+  □ [URL] - Stack Overflow discussions
+  □ [URL] - Conference talks
+```
+
+---
+
+## Phase 3: Systematic Research
+
+**Spawn:** `researcher` agent
+**Apply:** `research` skill
+
+### Researcher Instructions
+
+```
+Conduct systematic research on: [TOPIC]
+
+## Research Methodology
+
+### 1. Search Strategy
+Execute up to 5 focused searches:
+  - "[topic] best practices 2024"
+  - "[topic] official documentation"
+  - "[topic] vs [alternative]"
+  - "[topic] security considerations"
+  - "[topic] performance optimization"
+
+### 2. Source Evaluation
+For each source:
+  - Authority: Official/Expert/Community
+  - Recency: Date published
+  - Relevance: Direct/Indirect
+  - Quality: High/Medium/Low
+
+### 3. Information Extraction
+Extract:
+  - Key concepts and definitions
+  - Best practices
+  - Common pitfalls
+  - Code examples
+  - Performance benchmarks
+  - Security considerations
+
+### 4. Cross-Validation
+  - Verify across multiple sources
+  - Note conflicting information
+  - Identify consensus
+
+### 5. Synthesis
+  - Organize findings
+  - Draw conclusions
+  - Make recommendations
+
+## Output
+Save detailed notes to working memory for report generation.
+```
+
+### Research Execution
+
+```
+════════════════════════════════════════════════════════════════════
+                    🔍 RESEARCH IN PROGRESS
+════════════════════════════════════════════════════════════════════
+
+SEARCH 1: [query]
+  Status: ✓ Complete
+  Sources found: [X]
+  Key findings: [summary]
+
+SEARCH 2: [query]
+  Status: ✓ Complete
+  Sources found: [X]
+  Key findings: [summary]
+
+[Continue for each search...]
+
+DOCUMENTATION REVIEWED:
+  ✓ [Doc 1] - [key takeaways]
+  ✓ [Doc 2] - [key takeaways]
+  ✓ [Doc 3] - [key takeaways]
+
+════════════════════════════════════════════════════════════════════
+```
+
+---
+
+## Phase 4: Analysis & Synthesis
+
+**Apply:** `sequential-thinking` skill
+
+### Thought N/M: Synthesize Findings
+
+```
+════════════════════════════════════════════════════════════════════
+                    📊 RESEARCH SYNTHESIS
+════════════════════════════════════════════════════════════════════
+
+CONSENSUS FINDINGS:
+  - [Finding 1] - Supported by [X] sources
+  - [Finding 2] - Supported by [X] sources
+  - [Finding 3] - Supported by [X] sources
+
+CONFLICTING INFORMATION:
+  - [Topic]: Source A says [X], Source B says [Y]
+    Resolution: [which is more credible and why]
+
+GAPS IN RESEARCH:
+  - [What couldn't be found]
+  - [What needs more investigation]
+
+KEY INSIGHTS:
+  1. [Most important insight]
+  2. [Second important insight]
+  3. [Third important insight]
+
+════════════════════════════════════════════════════════════════════
+```
+
+---
+
+## Phase 5: Generate Report
+
+### Research Report
+
+```
+════════════════════════════════════════════════════════════════════
+                    📋 RESEARCH REPORT
+════════════════════════════════════════════════════════════════════
+
+# Research Report: [Topic]
+
+## Executive Summary
+
+[2-3 paragraph overview of key findings and recommendations]
+
+────────────────────────────────────────────────────────────────────
+                      METHODOLOGY
+────────────────────────────────────────────────────────────────────
+
+- **Sources consulted**: [number]
+- **Date range**: [earliest] to [most recent]
+- **Search queries**: [list]
+- **Documentation reviewed**: [list]
+
+────────────────────────────────────────────────────────────────────
+                      KEY FINDINGS
+────────────────────────────────────────────────────────────────────
+
+### 1. [Finding Category 1]
+
+[Detailed findings with evidence]
+
+**Source**: [citation]
+
+### 2. [Finding Category 2]
+
+[Detailed findings with evidence]
+
+**Source**: [citation]
+
+### 3. [Finding Category 3]
+
+[Detailed findings with evidence]
+
+**Source**: [citation]
+
+────────────────────────────────────────────────────────────────────
+                      BEST PRACTICES
+────────────────────────────────────────────────────────────────────
+
+1. **[Practice 1]**
+   - What: [description]
+   - Why: [rationale]
+   - How: [implementation]
+
+2. **[Practice 2]**
+   - What: [description]
+   - Why: [rationale]
+   - How: [implementation]
+
+────────────────────────────────────────────────────────────────────
+                      SECURITY CONSIDERATIONS
+────────────────────────────────────────────────────────────────────
+
+- [Security consideration 1]
+- [Security consideration 2]
+- [Security consideration 3]
+
+────────────────────────────────────────────────────────────────────
+                      PERFORMANCE
+────────────────────────────────────────────────────────────────────
+
+- [Performance characteristic 1]
+- [Performance characteristic 2]
+- [Optimization technique]
+
+────────────────────────────────────────────────────────────────────
+                      COMPARISON (if applicable)
+────────────────────────────────────────────────────────────────────
+
+| Aspect | Option A | Option B | Option C |
+|--------|----------|----------|----------|
+| [Aspect 1] | [value] | [value] | [value] |
+| [Aspect 2] | [value] | [value] | [value] |
+| [Aspect 3] | [value] | [value] | [value] |
+
+**Recommendation**: [which option and why]
+
+────────────────────────────────────────────────────────────────────
+                      IMPLEMENTATION GUIDE
+────────────────────────────────────────────────────────────────────
+
+### Quick Start
+
+```[language]
+[code example]
+```
+
+### Common Patterns
+
+```[language]
+[code example]
+```
+
+### Common Pitfalls
+
+1. **[Pitfall 1]**: [description and how to avoid]
+2. **[Pitfall 2]**: [description and how to avoid]
+
+────────────────────────────────────────────────────────────────────
+                      RESOURCES
+────────────────────────────────────────────────────────────────────
+
+### Official Documentation
+- [Link 1] - [description]
+- [Link 2] - [description]
+
+### Tutorials
+- [Link 1] - [description]
+- [Link 2] - [description]
+
+### Community
+- [Link 1] - [description]
+- [Link 2] - [description]
+
+────────────────────────────────────────────────────────────────────
+                      UNRESOLVED QUESTIONS
+────────────────────────────────────────────────────────────────────
+
+- [Question 1] - [why it matters]
+- [Question 2] - [why it matters]
+
+════════════════════════════════════════════════════════════════════
+
+Report generated: [date]
+```
+
+---
+
+## Phase 6: Save & Export
+
+```
+Question: How should I save this research?
+Header: Export
+Options:
+  - Save to .claude/tasks/[task-id]/research/ (then ask question about task id)
+  - Save to ./docs/research/
+  - Copy to clipboard
+  - Just display (don't save)
+```
+
+### Save Report
+
+```bash
+# Create directory
+mkdir -p .claude/tasks/[task-id]/research/$(date +%Y%m%d)-[topic]
+
+# Save report
+# File: .claude/tasks/[task-id]/research/YYYYMMDD-[topic]/report.md
+```
+
+---
+
+## Begin Now
+
+What topic should I research?
+