Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

Recording a screencast

How to plan, record, caption and publish a short screencast or video tutorial about Exponential - scope, script, clean setup, accessibility with captions and transcripts, licensing, and keeping it correct after new…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/advocates/recording-a-screencast.md

On this page

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

  1. Choose the scope
  2. Write a script
  3. Record clean
  4. Make it accessible
  5. Publish and license
  6. Keep it correct

Choose the scope

One video, one task. Good topics are tasks the help already describes, so viewers can read on:

TopicLengthHelp page to link
Install Exponential in one command3 minInstall in one command
Publish an article and compare versions3 minPublishing, versions and the trash
Build a page with the layouts editor4 minThe layouts editor
Translate an item2 minLanguages
Turn on two-step sign-in2 minYour account and signing in
Your first extension with the RAD tools6 minRAD tools
Fix a help page with Edit on GitHub3 minImproving 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

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.

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x