Interactive manuals: a how-to video next to every step

Paul Manning
Insight featured image

An interactive manual puts a short how-to video next to each step or section, so people can read the instruction and then watch it done. It helps when the words alone are not enough: a procedure, a policy, a piece of equipment.

Why manuals need video next to the words

  • Training is often recorded once and never found again.
  • People skip long videos but will watch one minute on the step they are stuck on.
  • When the video sits on the step it explains, nobody has to search for it.

What you need

  • The manual or handbook as a Word or Markdown file with real headings for each section.
  • Your recordings: training sessions, demonstrations, briefings.
  • One person who knows the material to check each link.

Step by step

1. Structure the manual

Make sure each section has a heading. In RoamBook, headings in Word and Markdown become the sections readers see. Numbered steps written as plain text are not split automatically yet, so use headings for now.

2. Upload your recordings

Add the video or audio files. Captions are made automatically.

3. Let the AI draft the links

RoamBook's AI suggests short clips from your recordings and the section each one explains.

4. Review and approve

Your editors accept, change or reject each suggestion in RoamBook Studio. Only approved clips are shown.

5. Share the reader

Staff or customers open the manual in the browser, under your name, and tap a section to watch the clip about it. A reader can be public or for members only.

What it does not do yet

PDF import and automatic splitting of numbered steps in plain text are not available today. Word and Markdown files with headings work now.

Questions

Can we see who watched which clip?

No. Organisations see counts of what readers tap and watch, not who watched what.

What happens when a procedure changes?

Upload the new version of the text, then check the clips on the sections that changed.

Do staff need an app?

No. The reader runs in the browser.