An onboarding guide is a document that tells your customer exactly what to do, in what order, to get value from your product. Without one, every new customer gets a different experience depending on who's available, what they remember, and how much time they have.
If you're building your first onboarding guide, you're in the right place. This article walks through what to include, how to structure it, and how to turn it into something your team can actually use. No theory. Just the practical steps.
Why you need an onboarding guide
You might think you don't need a formal guide. Your product is simple. Your team is small. You can just hop on a call with each new customer and walk them through it.
That works until it doesn't. Here's when it breaks:
- You hire a second person and they onboard customers differently than you do.
- A customer starts setup on a Friday afternoon when nobody's around to help.
- You realize three months in that your churn problem is actually an onboarding problem.
- You're spending 40% of your week on repetitive setup calls instead of building your product.
An onboarding guide solves all four problems. It creates consistency across your team, gives customers a self-serve path, and frees your time for work that actually scales.
If you've already started a basic process, our first onboarding process guide covers the foundations. This guide goes deeper into creating the actual document.
What makes a good onboarding guide
Before you start writing, you need to understand what separates a guide that customers follow from one they ignore.
It's task-based, not feature-based
Bad onboarding guides read like a product manual. "Here's Feature A. Here's Feature B. Here's Feature C." Customers don't care about your features in the abstract. They care about getting something done.
A good guide is organized around tasks: "Set up your first workspace." "Invite your team." "Create your first report." Each section answers the question "What do I do next?" not "What does this button do?"
It's short enough to finish
If your guide is 40 pages, nobody's reading it. Aim for a guide your customer can complete in one or two sessions. That usually means five to eight steps, each taking 10-30 minutes.
If your product genuinely requires a longer setup, break the guide into phases. Give customers a win at the end of each phase so they feel progress, not overwhelm.
It has clear owners
Every step in the guide should say who's responsible: the customer, your team, or both. Ambiguity kills momentum. When a step says "configure integrations" but doesn't say who does the configuring, it sits undone.
It defines done
Each step needs a success criteria. Not "set up your account" but "set up your account and verify you can see the dashboard with sample data." When customers know what "done" looks like, they move faster.
What to include in your guide
Here's a section-by-section breakdown of what belongs in a customer onboarding guide.
Section 1: Welcome message
The welcome section sets the tone. Keep it short, three to four sentences at most. It should cover:
- Who this guide is for. "This guide is for new customers setting up their first workspace."
- What they'll accomplish. "By the end, you'll have a working onboarding portal your customers can access."
- How long it takes. "Most customers complete setup in about 45 minutes."
Don't use this section for a company history or a thank-you letter. Your customer just bought your product. They want to use it, not read about your mission statement.
Section 2: What you'll need
List everything the customer needs before they start. This prevents the frustrating experience of getting halfway through setup and realizing they need an admin password they don't have.
Common items to include:
- Login credentials or invitation link
- Admin access to any systems they'll connect
- Company logo and branding assets (if your product uses them)
- A list of team members who need access
- Any data files they'll need to import
Put this section near the top so customers can gather everything before they begin.
Section 3: Account setup
Walk through the first steps of getting the product configured. Be specific. "Click the gear icon in the top left, then select Workspace Settings" is better than "Go to your settings."
This section typically covers:
- Creating or logging into the account
- Configuring basic settings (company name, timezone, branding)
- Setting up team roles and permissions
- Connecting email or notification preferences
Include screenshots or short descriptions of what the customer should see at each step. When something looks different from what the guide says, customers stop and open a support ticket.
Section 4: Core setup tasks
This is the heart of your guide. These are the two to four tasks that get your customer to their first real value with the product.
The key here is focus. Don't try to cover every feature. Cover the features that matter most in the first week. Everything else can come later through in-app prompts, emails, or follow-up guides.
For each task, include:
- What to do. Clear, step-by-step instructions.
- Why it matters. One sentence connecting this task to the customer's goal.
- What done looks like. How they know they've completed it correctly.
- Who does it. The customer, your team, or both.
For example, if you're building a guide for OnboardingHub, your core setup tasks might be: create your first guide, add steps to it, customize the customer portal, and enroll a test customer.
Section 5: Integrations and data import
If your product connects to other tools, dedicate a section to setting up integrations. Customers often skip this step because it feels technical and optional. Your guide should explain why each integration matters and make the setup as painless as possible.
For data imports, include:
- What file formats you accept
- Where to find the export option in their current tool
- A sample file they can reference
- What to do if the import fails
If your product has an API, don't include the full docs here. Link to your API documentation and move on.
Section 6: Team onboarding
Your primary contact probably isn't the only person who'll use your product. Include a section on how to bring their team on board. Cover how to invite team members, what permissions to assign, and what each team member should do first.
This is a good place to mention that OnboardingHub lets you create different guides for different roles. An admin guide and an end-user guide can live in the same workspace, each tailored to what that person needs.
Section 7: Timeline and milestones
Give customers a realistic timeline for their onboarding. Break it into milestones so they can track their own progress.
A typical timeline might look like:
- Day 1: Account setup and core configuration
- Days 2-3: Integrations and data import
- Days 4-5: Team invitations and role setup
- Week 2: First customer enrolled and live
- Week 3: Review initial results and adjust
Be honest about timing. If a step requires waiting for approval from their IT team, say so. Customers appreciate realistic expectations more than optimistic ones.
Section 8: Support and next steps
End with clear support information and what comes next after onboarding is complete. Include:
- How to reach your support team (email, chat, phone)
- Support hours and expected response times
- Links to help docs and knowledge base
- What happens after onboarding: review call, ongoing check-ins, advanced training
Don't end with "Congratulations, you're done!" End with a specific next step. "Schedule your two-week review call with your CSM" or "Share your portal link with your first customer" gives the customer momentum to keep going.
Step-by-step: creating your guide
Now that you know what to include, here's how to actually build it.
Step 1: Map your customer's path to value
Before you write a single word, answer this question: what does the customer need to accomplish to feel like your product was worth buying?
This is your "aha moment," and every step in your guide should point toward it. For a project management tool, it might be "completing their first project with their team." For an analytics product, it might be "seeing their first dashboard with real data." For OnboardingHub, it's enrolling a real customer in a guide and watching them complete it.
Write down the three to five things that must happen to reach that moment. Those become your core sections.
Step 2: Interview your best customers
Your best customers figured out how to get value from your product. Talk to three to five of them and ask:
- What did you do first when you started using the product?
- What was confusing or unclear?
- What would have helped you get set up faster?
- What feature did you wish you'd known about sooner?
Their answers will tell you what to emphasize, what to explain more carefully, and what to skip. Read our customer onboarding process guide for more on identifying the steps that matter most.
Step 3: Write the first draft
Open a blank document and write your guide section by section, following the structure above. Don't worry about polish. Focus on accuracy and completeness.
A few writing tips:
- Use second person. "You" and "your," not "the user" or "one should."
- One instruction per sentence. "Click Save" is a sentence. "Click Save and then navigate to the dashboard and select your workspace" is three sentences crammed into one.
- Be specific about what they'll see. "A green confirmation banner appears at the top of the page" helps the customer know they did it right.
- Number your steps. Numbered lists are easier to follow than paragraphs of instructions, especially when someone is switching between your guide and your product.
Step 4: Test it with a real customer
Don't publish your guide until someone outside your team has tried to follow it. Find a customer who's about to start onboarding and ask them to use the guide. Watch where they get stuck, confused, or frustrated.
You'll find problems you never expected. A step that seems obvious to you will be confusing to someone seeing your product for the first time. A section you thought was clear will raise questions you didn't anticipate.
Fix those problems and test again with another customer. Two rounds of testing is usually enough to catch the major issues.
Step 5: Choose your format
Your guide needs to live somewhere your customer can easily access it. You have a few options:
A shared document (Google Docs, Notion). Simple and fast to create. Hard to track who's read it. Gets outdated quickly.
A PDF. Looks professional. Impossible to update once sent. No way to track completion.
A dedicated onboarding tool. A tool like OnboardingHub lets you build interactive guides with progress tracking, task assignments, and a customer-facing portal. You can see who's completed which steps and where people are getting stuck.
Your product itself. In-app onboarding flows work well for simple products. They don't work as well when setup requires actions outside your product, like gathering data from other tools or getting approvals from teammates.
For most B2B products, a combination works best: an onboarding tool for the structured process and in-app tooltips for feature-specific guidance.
Step 6: Build it in your tool
Once your content is finalized and your format is chosen, build the guide. If you're using OnboardingHub, start with one of the built-in templates and customize it with your content. The drag-and-drop builder lets you add steps, set due dates, and assign tasks to specific people.
Here's what to set up:
- Each section as a separate step or milestone
- Task assignments showing who owns each step (you or the customer)
- Due dates based on your recommended timeline
- Links to any supporting resources (help docs, videos, sample files)
- A completion trigger that marks onboarding as done
Step 7: Set up measurement
You can't improve your guide without data. Track these metrics from day one:
- Completion rate. What percentage of customers finish all steps? If it's below 70%, your guide is too long, too confusing, or not valuable enough.
- Time to complete. How long does the average customer take to finish onboarding? This is your baseline for improvement.
- Drop-off points. Where do customers stop? If 80% of customers complete step three but only 40% complete step four, step four needs work.
- Support tickets during onboarding. What questions come up that your guide should have answered?
OnboardingHub tracks all of this automatically and shows it in your progress analytics dashboard.
Examples of what good looks like
Here are a few patterns from effective onboarding guides.
The "quick win" opener
Start with a step that takes less than five minutes and gives the customer something visible. "Upload your logo and see it on your customer portal" takes 30 seconds and gives the customer a sense of ownership. Starting with a 45-minute data import does the opposite.
The parallel path
Not every step depends on the one before it. A well-designed guide lets the customer work on independent tasks at the same time. While they're waiting for IT to approve the SSO integration, they can be setting up their first guide and inviting team members.
The checkpoint call
Insert a call with your team at the midpoint of the guide, not just at the beginning and end. This catches problems early, answers questions the guide didn't cover, and re-engages customers who've stalled.
The "before and after" frame
In your welcome section, describe what life looks like before and after completing the guide. "Right now, you're onboarding customers with email chains and spreadsheets. By the end of this guide, you'll have a branded portal where customers can see their progress and complete tasks on their own." This gives the customer a reason to keep going.
Common mistakes to avoid
Writing for experts. You know your product inside and out. Your customer doesn't. Write for someone who has never seen your product before. If a term is specific to your product, define it the first time you use it.
Including everything. Your guide should cover the first one to two weeks, not the first six months. Advanced features, power-user tips, and edge cases belong in separate resources. Put them in your knowledge base and link to them.
Forgetting to update. Your product changes. Your guide should change with it. Set a calendar reminder to review your guide once a month. Check for outdated screenshots, deprecated features, and new steps that should be added.
Skipping the customer's perspective. You know your product's architecture. The customer knows their business problem. Write the guide from their perspective, organized around what they're trying to accomplish, not around how your product is built.
Making it too pretty too soon. A plain-text guide that's accurate is more useful than a beautifully designed guide that's wrong. Get the content right first. Polish it later.
Start building your guide
You now have the structure, the content framework, and the process. Pick up a blank document and start writing your welcome section. You can create your first draft in an afternoon.
If you want a head start, OnboardingHub includes built-in templates you can customize for your product, pre-built with task assignments and timelines.
For a visual, drag-and-drop way to build and manage your onboarding guides, try OnboardingHub free. You'll have a working guide with a customer-facing portal in minutes, not weeks. Check the guides section for more resources on building an onboarding process that works.