Support Team Material

Video Tutorial

Onethread

Simple, Understandable Titles

Keep each doc title short and clear.

Avoid jargon—write like we’re explaining it to a beginner.

Example: ✅ “Connect Your Gmail Account” instead of “Third-party Email Integration via OAuth.”

Table of Contents (TOC) for Each Section

Start each guide with a small TOC if it's long.

This helps users understand what they’ll learn and quickly jump to what they need.

Step-by-Step Format with Screenshots

Break each guide into clear, numbered steps.

Add screenshots after each step.

Highlight where to click using boxes/arrows for clarity.

Example: Click “Create Campaign” from the left menu. (Add screenshot here with a red arrow pointing to the button)

Bullet Points or Short Explanations

Use bullet points for options or short notes inside steps.

This keeps things clean and skimmable.

Tips or Notes (Optional but Helpful)

Add useful reminders, common issues, or alternate paths.

Mark them clearly so users don’t miss them.

Example: Note: If you can’t find the 'Send' button, try zooming out your browser to 90%.

Outcome (Wrap-up)

End each guide with a one-liner confirmation so users know they’re done.

Example: You’ve successfully connected your Gmail and can now start sending emails.

Section Breakdown (for homepage layout)

Structure our documentation homepage into cards/sections like: Getting Started – installation, setup, onboarding

Settings & Preferences – account, UI, permissions

Core Features – key workflows and tools

Integrations – how to connect third-party apps

Billing & Account – subscription, payments, invoices

Troubleshooting – common issues and quick fixes

Use Preconditions Only Where Truly Needed

Avoid adding “Users must have an account…” everywhere.

Add such notes only if the action will break without it.

Keep it short and place it as a side note or inline in Step 1.

2. 👀 Show the Screenshot First or Early Don’t make users scroll through long text before seeing what to do.

Put the relevant image right after the step, or even before, if that helps the user recognize the UI.

3. ✂️ Cut Paragraphs into Steps or Bullets Avoid long blocks of text.

Break content into:

✅ Short steps

💡 Notes or tips

📌 Highlights (optional info)

Helps users stay focused and move faster.

4. 🎨 Improve Visuals – Light and Clean Use light or white backgrounds for all screenshots.

Add clear arrows, boxes, or highlights (use brand colors) to show the action points.

Avoid dark/low-contrast images that are hard to read.

5. 📚 Organize by Topic – Not Randomly Use 5–6 core categories only.

Getting Started

Dashboard & Settings

Key Features

Team/Clients/Users

Payments & Billing

Troubleshooting

Each guide belongs to only one category.

6. 🔗 Suggest Related Guides At the bottom or side of each doc, show “Related Guides” like:

→ How to Invite Team Members

→ Common Dashboard Settings

Helps users naturally explore the next steps.

7. 🧭 Easy Navigation with Table of Contents For long pages, include a small TOC at the top.

Makes it easier to jump to sections quickly.

8. 🎯 End with a Quick Wrap-Up At the end of each guide, write: “🎯 You’ve successfully completed [task]. You can now [do next thing].”

📁 Two Types of Videos Intro/Explainer Videos

Short videos that introduce what the platform or a specific module does.

Goal: Help users explore features, understand the value.

Length: Max 1–2 minutes.

How-to Tutorials (Step-by-Step)

Based on our user guide and common support questions.

Each video shows ONE small task (like adding a client, creating a proposal).

Length: Max 2–4 minutes per video.

✅ Before Recording – Always Prepare a Checklist What’s the topic of the video?

Is there a related user guide page for this?

What steps will I show on screen?

Any pre-condition (e.g., “Must be logged in”)?

What’s the goal the user will achieve?

Any common issue or tip to mention?

🎬 Structure of Each Video Title screen (Optional) Just show the name of the topic in text, or say it in the intro.

Short intro (5–10 seconds) “In this video, I’ll show you how to [do something].”

Pre-condition (if needed) Example: “Make sure you’re logged in and have access to [module name].”

Step-by-step screen recording Show exactly what to click, where to go. Use your mouse naturally and slowly. Pause for a second on key clicks.

Highlight clicks or fields with mouse cursor or screen recorder tools You can draw boxes or arrows using your screen recorder if possible. If not, just hover clearly.

Wrap-up (🎯 Outcome) “You’ve now successfully [finished the task].”

Optional: Link to related video/topic “Next, you can check out how to [related action].”

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.