Recording a screencast
This page is for advocates who want to make a video: a two-minute "how to" or a longer walkthrough. Videos reach people who do not read documentation, but they age quickly and leak secrets easily. Plan short, record clean, caption everything, and say which version you show.
Contents
Choose the scope
One video, one task. Good topics are tasks the help already describes, so viewers can read on:
| Topic | Length | Help page to link |
|---|---|---|
| Install Exponential in one command | 3 min | Install in one command |
| Publish an article and compare versions | 3 min | Publishing, versions and the trash |
| Build a page with the layouts editor | 4 min | The layouts editor |
| Translate an item | 2 min | Languages |
| Turn on two-step sign-in | 2 min | Your account and signing in |
| Your first extension with the RAD tools | 6 min | RAD tools |
| Fix a help page with Edit on GitHub | 3 min | Improving the help |
Write a script
SCREENCAST SCRIPT Version shown: Exponential <6.0.x> Design: <admin4>
Title: <task, as the viewer would search it>
Goal: After this video you can <task>.
Help page: <link>
0:00 Intro: "In this video: <task>. I'm <name>, a volunteer." (disclosure)
0:10 Step 1: <click> - say: <sentence>
0:40 Step 2: ...
2:30 Result: show what changed
2:45 Outro: "The help page is linked below. Questions: forums or Telegram."Use the button and menu names exactly as on screen, in bold in the transcript (Brand and naming rules, Language and spelling).
Record clean
- Follow Live demo safety: a fresh installation, invented content, no keys or passwords on screen, notifications off.
- Record one window at a readable zoom; viewers watch on phones.
- Move the mouse slowly; pause on each click.
- Record the voice separately if you can; it is easier to fix.
- Watch the whole recording before publishing, frame by frame where a sign-in or an error page appears.
Make it accessible
- Captions: correct captions, not only automatic ones; product names spelled right.
- Transcript: post it with the video; it also makes the video searchable.
- Describe actions aloud: "I press Send for publishing", not "I click here".
- No information only in color or only on screen: say it too.
- No flashing content.
More: Accessible slides and visuals.
Publish and license
- Title with the task; first line of the description: "Shows Exponential <version>".
- Link the help page and the community channels in the description.
- Choose a license for your video and state it. If you show or read help pages, remember they are under the GNU FDL; quoting with a link is the simple way (Citing sources and licensing your writing).
- Disclose if anyone paid for the video (Disclosure and conflicts of interest).
- Share it in the forums and on Share (Publishing on Share and Projects).
Keep it correct
- After each release, check the changelog for changes to the screens you show (6.0.15 changelog).
- When the video is wrong, add a pinned comment with the correction, then re-record.
- When it is obsolete, say so in the title or description, or unlist it.
Related pages
- Writing a tutorial that works
- Live demo safety
- Social post templates
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.