mirror of
https://github.com/ruvnet/ruflo.git
synced 2026-11-09 22:13:39 +09:00
Tutorials and Guides
Step-by-step tutorials and comprehensive guides for using Claude Flow features.
Directory Structure
06-tutorials/
├── getting-started/ # Beginner tutorials
├── sparc/ # SPARC methodology guides
├── workflows/ # Workflow orchestration tutorials
├── advanced/ # Advanced features and patterns
└── sparc-batchtool-orchestration.md # Original BatchTool guide
Tutorial Categories
Getting Started (getting-started/)
- 01-first-swarm.md: Create your first swarm and understand basics
- Swarm creation and execution
- Understanding agent roles
- Customizing behavior
- Running generated applications
SPARC Methodology (sparc/)
- sparc-tdd-guide.md: Complete SPARC TDD workflow guide
- Specification → Pseudocode → Architecture → Refinement → Completion
- Test-driven development with AI
- Security reviews and integration
- Best practices and patterns
Workflow Orchestration (workflows/)
- multi-agent-coordination.md: Advanced multi-agent coordination
- Agent specialization and roles
- Dependency management
- Coordination patterns (hub-spoke, mesh, pipeline)
- Performance optimization
- Error handling and recovery
Legacy Tutorial
sparc-batchtool-orchestration.md
Original comprehensive guide to BatchTool with SPARC modes covering:
- Parallel execution patterns
- Dependency management
- CI/CD integration
Tutorial Topics
Getting Started
- System setup and configuration
- First swarm creation
- Understanding agent roles
- Basic task execution
Advanced Features
- Custom agent capabilities
- Memory persistence
- Quality thresholds
- Monitoring and logging
- Error recovery
Integration Patterns
- CI/CD pipelines
- Automated testing
- Code generation workflows
- Documentation automation
Best Practices
- Agent specialization
- Task decomposition
- Resource optimization
- Security considerations
Using Tutorials
Each tutorial includes:
- Prerequisites: What you need to know
- Step-by-step instructions: Clear, numbered steps
- Code examples: Working demonstrations
- Troubleshooting: Common issues and solutions
- Next steps: Where to go from here
Contributing Tutorials
When writing new tutorials:
- Start with clear objectives
- Include working examples
- Explain the "why" not just "how"
- Add diagrams where helpful
- Test all code examples
- Include common pitfalls
Tutorial Format
# Tutorial Title
## Overview
Brief description of what will be learned
## Prerequisites
- Required knowledge
- System requirements
- Previous tutorials
## Steps
1. **Step Title**
- Explanation
- Code example
- Expected output
## Troubleshooting
- Common error: Solution
- Issue: Resolution
## Summary
- What was learned
- Key takeaways
- Next tutorials