Spec

Plan and author a Sunboard onboarding spec.

/sunboard.spec plans, authors, or revises an onboarding experience for your product. It's a customer-success planning mode before it's a YAML-writing mode: the agent helps you choose a measurable outcome, decide who should see the experience, and design the shortest useful path to value.

When to use it

  • Starting onboarding from scratch.
  • Revising an existing experience's steps, copy, goal, or audience.
  • Any time — the spec always comes before implementing or deploying.

What happens

  1. Studies your product — README, routes, entry points, and existing specs in sunboard/specs/.
  2. Reads hosted state with sunboard state so it reuses experience keys and segments instead of inventing parallel ones.
  3. Runs a short strategy interview — your ICP and roles, the "aha" moment, the must-have setup, time-to-value, and who should (and shouldn't) see onboarding.
  4. Picks one measurable activation event — value, not configuration (e.g. workflow.created, not profile.completed).
  5. Drafts a plan, then writes the spec to sunboard/specs/<key>.yaml — an ordered checklist (usually 3–5 steps), optional tours/hotspots, personalized copy, and a completion screen.
  6. Validates it with sunboard validate and flags any assumptions to confirm.

What you get

A spec file in your repo, plus a short customer-success plan: the activation goal, the suggested segment and exclusions, the data-sunboard-id selectors and track() calls that still need wiring, and the analytics to watch.

The spec is a plan, not a deploy

/sunboard.spec writes and validates the spec locally — it never ships anything. Wiring happens in Implement, shipping in Deploy. Targeting (who sees it) lives in Segment, not in the YAML.

On this page