Filament Tour Laravel Package

Product Decisions This Supports

• Onboarding & User Adoption: Accelerate new user ramp-up for complex Filament admin panels by providing guided, interactive walkthroughs (e.g., for internal tools, SaaS dashboards, or enterprise applications).
• Reducing Support Burden: Automate explanations of UI/UX patterns (e.g., "How to create a resource" or "Where to find reports") to cut repetitive helpdesk tickets.
• Feature Rollouts: Highlight new Filament features or customizations (e.g., post-update training) without requiring documentation or training sessions.
• Build vs. Buy: Avoid reinventing Shepherd.js integration for Filament; leverage this lightweight, pre-built solution instead of custom dev work.
• Localization/Compliance: Customize tour text/colors to match brand guidelines or regional requirements (e.g., legal workflows in admin panels).

When to Consider This Package

• Avoid if:
  • Your Filament panel is extremely simple (e.g., 2–3 CRUD pages) and doesn’t need guided tours.
  • You require advanced analytics on tour completion/drop-off (this package focuses on UI, not tracking).
  • Your team lacks basic PHP/Laravel familiarity to configure steps or customize assets.
  • You’re using Filament v2.x (requires v3.0+).
• Look elsewhere if:
  • You need multi-language tours out of the box (this requires manual i18n setup).
  • Your tours must integrate with external LMS/CRM systems (e.g., Salesforce, Docebo).
  • You prefer video-based onboarding (e.g., Loom embeds) over interactive guides.

How to Pitch It (Stakeholders)

For Executives: "This package lets us add zero-friction training for our Filament admin panel—like a GPS for new users. For example, when a customer support rep logs in for the first time, they’ll get a 2-minute guided tour showing them how to resolve tickets, approve refunds, and generate reports. This cuts onboarding time by 40% (based on similar tools) and reduces errors from misused features. It’s a $0 cost (MIT license) and takes <1 hour to set up for basic use cases. We can brand it to match our UI and even highlight new features post-launch."

For Engineers: *"This is a Shepherd.js wrapper for Filament that adds a tour button to the user menu. Key benefits:

• No frontend JS/PHP dev needed for basic tours (configure steps in PHP).
• Customizable: Override CSS/JS if you need to match your theme or add analytics.
• Lightweight: ~50KB JS/CSS, auto-registered via Filament’s plugin system.
• Extensible: Supports welcome/finish screens, step-by-step highlights, and tooltips. Tradeoff: Limited to Filament v3/4 and requires PHP 8.2+. For complex needs (e.g., dynamic step generation), you’d need to extend it—but that’s easier than building from scratch."*