Research Agent: Video Walkthroughs & Demos
Welcome, guys! Today, we're diving deep into making Research Agent even more accessible and user-friendly. How, you ask? By creating a series of comprehensive video walkthroughs and demonstrations! Video content is king when it comes to learning, and these demos will show you exactly how to harness the power of Research Agent in real-world scenarios. Let's get started!
Overview
The goal here is simple: create video walkthroughs and demonstrations to help users learn and adopt research-agent effectively. These videos will serve as a visual guide, showcasing the plugin's features and capabilities in action. By providing step-by-step instructions and practical examples, we aim to lower the barrier to entry and empower users to leverage the full potential of Research Agent.
Background
Video content is highly effective for learning because, let's face it, sometimes reading walls of text just doesn't cut it. Demonstrations show real-world usage and help users understand the plugin's value and capabilities far more effectively than written documentation alone. Seeing is believing, and these videos will demonstrate the power and versatility of Research Agent in a clear, concise, and engaging manner.
Tasks
To bring this vision to life, we've outlined a series of tasks:
- [x] Plan video content structure
- [x] Create video scripts
- [x] Record getting started tutorial
- [x] Record feature demonstrations (one per command/skill)
- [x] Record advanced techniques video
- [x] Record troubleshooting guide
- [x] Create animated GIFs for README
- [x] Edit and produce videos
- [x] Upload to YouTube/platform
- [x] Embed in documentation
- [x] Create video playlist
- [x] Add captions/subtitles
Each of these tasks is crucial to ensuring that our video content is high-quality, informative, and easily accessible to all users.
Video Content Plan
We've carefully planned the content for each video to ensure a smooth and effective learning experience.
1. Getting Started (5-7 minutes)
This video will provide a quick introduction to Research Agent, covering its purpose, installation, and basic usage.
Script Outline:
0:00 - Introduction
- What is research-agent?
- Why use it?
0:30 - Installation
- Show installation process
- Verify plugin loaded
1:30 - First Investigation
- /investigate authentication
- Walk through output
- Explain file references
3:00 - First Best Practice Lookup
- /best-practice React hooks
- Show recommendations
- Explain citations
4:30 - Quick Pattern Analysis
- Auto-activation demo
- "What patterns are used?"
- Review findings
6:00 - Next Steps
- Encourage experimentation
- Point to documentation
This Getting Started video is designed to be a gentle introduction to research-agent, showing new users how to quickly install the plugin and run their first investigations. We'll cover the basics of authentication, best practices, and pattern analysis, giving viewers a taste of what research-agent can do. By walking through the installation process and demonstrating key features, we aim to make the plugin accessible to users of all skill levels. The video will emphasize the ease of use and the time-saving benefits of research-agent, encouraging viewers to explore the plugin further and delve into more advanced topics. Furthermore, we will provide clear and concise explanations of the output and file references, ensuring that users understand the information presented and can effectively utilize it in their projects. The video will conclude with a call to action, urging viewers to experiment with the plugin and consult the documentation for more detailed information. We'll also highlight the active community and support channels, encouraging users to seek help and share their experiences with research-agent. The aim is to create a welcoming and supportive environment where users can learn, collaborate, and contribute to the ongoing development of the plugin.
2. Deep Investigation Tutorial (8-10 minutes)
This tutorial will demonstrate how to conduct a comprehensive codebase investigation using Research Agent.
Topics:
- Comprehensive codebase investigation
- Tracing execution flows
- Understanding complex systems
- Following dependencies
- Documenting findings
Demo Scenario:
Investigate a real open-source project's authentication system from scratch
In this Deep Investigation Tutorial, we'll dive into the intricacies of using research-agent to dissect and understand complex codebases. We'll guide you through the process of tracing execution flows, following dependencies, and documenting your findings. The tutorial will feature a demo scenario where we investigate a real open-source project's authentication system from scratch. This hands-on approach will provide viewers with a practical understanding of how to apply research-agent to their own projects. We'll explore techniques for navigating large codebases, identifying key components, and unraveling intricate relationships between modules. The tutorial will also cover best practices for documenting your findings, including creating clear and concise summaries, diagrams, and annotations. By the end of this video, you'll be equipped with the skills and knowledge to confidently tackle even the most challenging codebases. We'll also touch on advanced features of research-agent, such as its ability to identify potential security vulnerabilities and performance bottlenecks. The tutorial will emphasize the importance of a systematic and methodical approach to codebase investigation, highlighting the value of research-agent as a powerful tool for developers of all skill levels. The aim is to empower viewers to become more effective and efficient in their code analysis, leading to better software quality and faster development cycles. The tutorial will conclude with a Q&A session, addressing common questions and providing additional tips and tricks for maximizing the effectiveness of research-agent in deep investigation scenarios. We'll also encourage viewers to share their own experiences and contribute to the ongoing improvement of the plugin.
3. Best Practices Research (6-8 minutes)
This video will show you how to research current standards and apply them to your project using Research Agent.
Topics:
- Researching current standards
- Framework-specific practices
- Security considerations
- Comparing with current code
- Applying recommendations
Demo Scenario:
Research Next.js App Router best practices and apply to project
This Best Practices Research tutorial will guide you through the process of using research-agent to identify and implement current best practices in your projects. We'll cover how to research standards specific to your framework, address security considerations, compare them with your existing code, and apply the recommendations. The demo scenario will focus on researching Next.js App Router best practices and applying them to a project. This practical example will showcase the power of research-agent in helping you stay up-to-date with the latest industry standards. We'll explore techniques for identifying relevant resources, evaluating the credibility of information, and adapting best practices to your specific project context. The tutorial will also emphasize the importance of continuous learning and adaptation in the ever-evolving world of software development. By the end of this video, you'll be equipped with the skills and knowledge to confidently research and implement best practices in your projects, leading to improved code quality, security, and maintainability. We'll also touch on advanced features of research-agent, such as its ability to identify potential conflicts between different best practices and its integration with other development tools. The tutorial will highlight the value of research-agent as a proactive tool for preventing errors and ensuring that your code adheres to the highest standards. The aim is to empower viewers to become more knowledgeable and effective in their development practices, leading to better software outcomes. The tutorial will conclude with a discussion on the importance of code reviews and continuous integration in maintaining code quality and ensuring that best practices are consistently followed. We'll also encourage viewers to contribute to the ongoing improvement of best practices by sharing their own experiences and insights with the community.
4. Pattern Analysis Masterclass (10-12 minutes)
Learn how to find design patterns, detect code duplication, and identify refactoring opportunities.
Topics:
- Finding design patterns
- Architectural pattern recognition
- Code duplication detection
- Refactoring opportunities
- Anti-pattern identification
Demo Scenario:
Complete pattern analysis of a medium-sized codebase
5. Comparative Analysis (7-9 minutes)
This video will teach you how to compare different technologies and make informed decisions.
Topics:
- Technology comparison framework
- Weighted decision matrices
- Trade-off analysis
- Context-specific recommendations
- Making informed decisions
Demo Scenario:
Compare Redux vs Zustand for a specific project context
6. Advanced Techniques (12-15 minutes)
Explore advanced Research Agent techniques, including combining multiple research approaches and custom workflows.
Topics:
- Combining multiple research approaches
- Using cache effectively
- Learning log workflow
- Custom research workflows
- Integration with other tools
Demo Scenarios:
- Multi-step investigation workflow
- Building personal knowledge base
- Team knowledge sharing
7. Troubleshooting Common Issues (5-7 minutes)
This guide will help you troubleshoot common issues and find solutions.
Topics:
- Skill not auto-activating
- Commands not working
- Missing resources
- Validation errors
- Performance issues
Solutions:
- Debugging steps
- Common fixes
- Where to get help
Animated GIFs for README
To further enhance the user experience, we'll create animated GIFs showcasing core workflows.
Core Workflows (30-60 seconds each)
-
Investigation Workflow
[GIF: investigation-demo.gif] - Type: /investigate authentication - Show: Output with file references - Highlight: Key sections -
Pattern Analysis
[GIF: pattern-analysis.gif] - Type: "What patterns are used?" - Show: Auto-activation - Display: Pattern findings -
Best Practice Lookup
[GIF: best-practice.gif] - Type: /best-practice JWT auth - Show: Recommendations - Highlight: Code examples -
Comparison
[GIF: comparison.gif] - Type: /compare REST vs GraphQL - Show: Matrix comparison - Display: Recommendation
Video Production Quality
We're committed to producing high-quality videos that are both informative and engaging.
Requirements
- Resolution: 1080p minimum (1920x1080)
- Frame Rate: 30 fps minimum
- Audio: Clear voiceover, noise-free
- Length: Keep each video focused and concise
- Pacing: Not too fast, allow time to read output
- Captions: Add for accessibility
Tools
- Screen recording: OBS Studio, ScreenFlow, Camtasia
- Editing: DaVinci Resolve, Adobe Premiere, iMovie
- GIF creation: LICEcap, Kap, Gifox
- Thumbnails: Figma, Canva
Video Hosting
Our videos will be hosted on multiple platforms to maximize accessibility.
Primary: YouTube
- Create playlist: "Research Agent Plugin Tutorials"
- Optimize titles and descriptions for search
- Add timestamps in description
- Enable community contributions (captions)
- Create custom thumbnails
Secondary: GitHub Repository
- Add GIFs to README.md
- Embed videos in documentation
- Host downloadable versions
Additional: Documentation Site
- Embed videos in relevant sections
- Create video gallery
- Link from examples
Video Thumbnails
Attractive and consistent thumbnails will help users quickly identify the content they're looking for.
Design attractive, consistent thumbnails:
- Plugin logo
- Topic title
- Video duration
- Visual preview of content
- Consistent branding
Example:
ββββββββββββββββββββββββββββββββββ
β Research Agent Logo β
β β
β [Screenshot of Investigation] β
β β
β "Deep Investigation β
β Tutorial" 8:23 β
ββββββββββββββββββββββββββββββββββ
Interactive Elements
We'll use interactive elements to enhance engagement and provide additional resources.
YouTube Cards
- Link to next video
- Link to documentation
- Link to GitHub repository
Chapters/Timestamps
0:00 Introduction
0:45 Installation
1:30 First Investigation
3:15 Understanding Output
5:00 Next Steps
End Screens
- Subscribe button
- Next video suggestion
- Playlist link
- Documentation link
Accessibility
Accessibility is a top priority. We'll ensure our videos are accessible to all users.
Captions
- Auto-generated as baseline
- Manually reviewed and corrected
- Multiple languages (future):
- English
- Spanish
- French
- German
- Chinese
Transcripts
- Full text transcripts
- Downloadable format
- Searchable content
Audio Descriptions
- Describe visual elements
- Explain what's happening on screen
- Helpful for visually impaired users
Video Series Structure
Our videos will be organized into a series, catering to different skill levels.
Beginner Series
- Getting Started (5 min)
- Your First Investigation (7 min)
- Finding Best Practices (6 min)
Intermediate Series
- Pattern Analysis (10 min)
- Comparative Research (8 min)
- Advanced Commands (9 min)
Advanced Series
- Research Workflows (12 min)
- Knowledge Management (10 min)
- Team Collaboration (11 min)
Specialty Videos
- Troubleshooting Guide (6 min)
- Tips & Tricks (8 min)
- Real-World Case Studies (15 min)
Promotion Strategy
We'll actively promote our videos to reach a wider audience.
Launch
- Announce on GitHub
- Share on social media
- Post to relevant communities (Reddit r/programming, etc.)
- Add to Claude Code plugins showcase
Ongoing
- Share new videos as released
- Create shorts/clips from longer videos
- Respond to comments
- Update based on feedback
Metrics & Iteration
We'll track video performance and iterate based on feedback and analytics.
Track video performance:
- View count
- Watch time
- Engagement (likes, comments)
- Completion rate
- Click-through to documentation
Iterate based on:
- Viewer feedback
- Analytics data
- Common questions
- Feature updates
Acceptance Criteria
We'll consider this phase complete when all planned videos are created, published, and meet our quality standards.
- All planned videos created and published
- Videos have good production quality (1080p, clear audio)
- Captions added to all videos
- Animated GIFs created for README
- Video playlist organized on YouTube
- Videos embedded in documentation
- Thumbnails designed and applied
- Promotion plan executed
- Metrics tracking set up
Priority
LOW - Enhancement for 2.0 release
Related
See: research-agent/REVIEW_2025-01-15.md - Suggested Enhancement #2 (Examples Library)
Example Video Script
# Video Script: Getting Started with Research Agent
[INTRO - 0:00]
Hi! Welcome to this tutorial on the Research Agent plugin for Claude Code.
Research Agent helps you investigate unfamiliar codebases, discover best
practices, and analyze patterns - all through simple commands.
Let's get started!
[INSTALLATION - 0:30]
First, let's install the plugin.
[Show terminal]
```bash
claude plugin install research-agent
Great! The plugin is now installed. Let's verify...
[Show: claude plugin list]
Perfect! Research Agent is active.
[FIRST INVESTIGATION - 1:30] Let's try our first investigation. I have a project here and I want to understand how authentication works.
[Type command]
/investigate authentication
[Wait for output, highlight key sections]
Notice how it found the auth files, traced the execution flow, and identified the patterns used. All with file references so I can dive deeper if needed.
[Continue script...]