/f5-tutorial

description: Interactive F5 tutorials
argument-hint: [topic]

/f5-tutorial - F5 Framework Interactive Tutorial

> **Purpose**: Interactive learning experience for F5 Framework features > **Version**: 2.0.0 > **Category**: Education

---

Command Syntax

# Start tutorial from beginning
/f5-tutorial

# Start specific chapter
/f5-tutorial --chapter <number>

# Start specific topic
/f5-tutorial --topic <name>

# Quick tips mode
/f5-tutorial tips

# Show progress
/f5-tutorial progress

# Reset progress
/f5-tutorial reset

# List all chapters
/f5-tutorial list

# Verbosity (tutorial always uses level 5)
/f5-tutorial --v5

---

Input Processing

1. Parse Arguments

| Argument | Description | Default | |----------|-------------|---------| | `--chapter` | Start specific chapter | 1 | | `--topic` | Start specific topic | - | | `tips` | Show random tips | - | | `progress` | Show completion status | - | | `reset` | Reset tutorial progress | - | | `list` | List all chapters | - |

2. Tutorial Structure

| Chapter | Title | Topics | |---------|-------|--------| | 1 | Getting Started | 5 | | 2 | Project Configuration | 4 | | 3 | Quality Gates | 6 | | 4 | Memory System | 4 | | 5 | Personas & Modes | 5 | | 6 | TDD Workflow | 4 | | 7 | Advanced Features | 5 | | 8 | Best Practices | 4 |

---

Chapter Content

Chapter 1: Getting Started

═══════════════════════════════════════════════════════════════
           📚 F5 TUTORIAL - CHAPTER 1: GETTING STARTED
═══════════════════════════════════════════════════════════════

Welcome to F5 Framework! Let's learn the basics.

TOPICS IN THIS CHAPTER:
───────────────────────────────────────────────────────────────
1.1 What is F5 Framework?
1.2 Installing F5
1.3 Your First Project
1.4 Essential Commands
1.5 Getting Help

───────────────────────────────────────────────────────────────
Type 'next' to continue, 'skip' to skip, or topic number (1.1)
═══════════════════════════════════════════════════════════════

Topic 1.1: What is F5 Framework?

═══════════════════════════════════════════════════════════════
           📖 TOPIC 1.1: WHAT IS F5 FRAMEWORK?
═══════════════════════════════════════════════════════════════

F5 Framework is an Enterprise Spec-Driven Development Toolkit
designed for Japanese outsource workflows.

KEY FEATURES:
───────────────────────────────────────────────────────────────
🎯 Quality Gates     - D1 → D2 → D3 → D4 → G2 → G3 → G4
🧠 Memory System     - Constitution, Session, Decisions, Learnings
👤 Personas          - Specialized roles for different tasks
📊 Analytics         - Track usage and get insights
🔧 Traceability      - Link code to requirements

SUPPORTED WORKFLOWS:
───────────────────────────────────────────────────────────────
• Full project from requirements → deployment
• Basic design starting point (customer provides SRS)
• Detail design starting point (customer provides design)
• Change request / maintenance mode

───────────────────────────────────────────────────────────────
💡 TIP: F5 works best with clear requirements and defined gates

Type 'next' to continue or 'back' to go back
═══════════════════════════════════════════════════════════════

Topic 1.2: Installing F5

═══════════════════════════════════════════════════════════════
           📖 TOPIC 1.2: INSTALLING F5
═══════════════════════════════════════════════════════════════

F5 Framework is installed via slash commands in Claude Code.

REQUIREMENTS:
───────────────────────────────────────────────────────────────
✅ Claude Code or Claude with Projects
✅ Workspace with write permissions
✅ (Optional) MCP servers for enhanced features

INSTALLATION STEPS:
───────────────────────────────────────────────────────────────
1. Create a new project directory

2. Initialize F5 Framework:
   /f5-init my-project

3. Verify installation:
   /f5-selftest

4. Load project context:
   /f5-load

VERIFICATION:
───────────────────────────────────────────────────────────────
After running /f5-init, you should see:

  .f5/
  ├── config.json
  ├── profile.yaml
  ├── memory/
  └── quality/

───────────────────────────────────────────────────────────────
🎯 TRY IT: Run /f5-init test-project to create a test project

Type 'next' to continue or 'try' to practice
═══════════════════════════════════════════════════════════════

Topic 1.3: Your First Project

═══════════════════════════════════════════════════════════════
           📖 TOPIC 1.3: YOUR FIRST PROJECT
═══════════════════════════════════════════════════════════════

Let's create your first F5 project step by step.

STEP 1: INITIALIZE
───────────────────────────────────────────────────────────────
/f5-init my-first-project --starting-point requirements

This creates:
• Project configuration
• Memory system structure
• Quality gate templates
• Initial checklist files

STEP 2: CONFIGURE
───────────────────────────────────────────────────────────────
Edit .f5/config.json:
{
  "name": "my-first-project",
  "domain": { "name": "e-commerce" },
  "stack": { "backend": ["nestjs"], "frontend": "react" }
}

STEP 3: LOAD CONTEXT
───────────────────────────────────────────────────────────────
/f5-load

This loads:
• Project configuration
• Memory system
• Quality gates status
• Domain knowledge

STEP 4: CHECK STATUS
───────────────────────────────────────────────────────────────
/f5-status

See your project state and next recommended actions.

───────────────────────────────────────────────────────────────
🎯 TRY IT: Create a test project and explore its structure

Type 'next' to continue or 'try' to practice
═══════════════════════════════════════════════════════════════

Topic 1.4: Essential Commands

═══════════════════════════════════════════════════════════════
           📖 TOPIC 1.4: ESSENTIAL COMMANDS
═══════════════════════════════════════════════════════════════

Here are the commands you'll use most often:

SESSION COMMANDS:
─────────────────