Guidelines for videos and tutorials

A place to share learning material: written tutorials, videos, etc.
chrisb
Posts: 37693
Joined: Tue Mar 17, 2015 9:14 am

Guidelines for videos and tutorials

Post by chrisb »

I would like to create a sticky topic in this subforum with some guidelines. Please add (and discuss) further proposals for some general rules, which can be compiled in such a topic.

My first suggestion is
  • Mention the FreeCAD version used

    Every tutorial should start with clearly stating for which version it was made. Video tutorials should state it in the description or at least within the first 15 seconds.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
sgrogan
Posts: 6446
Joined: Wed Oct 22, 2014 5:02 pm

Re: Guidelines for videos and tutorials

Post by sgrogan »

Videos should never auto-start.
After starting there should be a way to quit/pause.
"fight the good fight"
User avatar
Celica_Supra
Posts: 50
Joined: Sat Nov 03, 2018 11:18 pm
Contact:

Re: Guidelines for videos and tutorials

Post by Celica_Supra »

I would suggest calling out all hotkeys used, at least the first few times if they are used multiple times.
kisolre
Posts: 3344
Joined: Wed Nov 21, 2018 1:13 pm

Re: Guidelines for videos and tutorials

Post by kisolre »

Briefly describe expected level of FreeCAD understanding at the begining. If for example tutorial is for FEM user should know how to model the solid to be analyzed.
User avatar
PrzemoF
Posts: 3331
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: Guidelines for videos and tutorials

Post by PrzemoF »

Celica_Supra wrote: Wed Jul 31, 2019 8:05 am I would suggest calling out all hotkeys used, at least the first few times if they are used multiple times.
key-mon [1] or other tool showing keys/mouse buttons pressed are really handy for that.

[1] https://code.google.com/archive/p/key-mon/
User avatar
Celica_Supra
Posts: 50
Joined: Sat Nov 03, 2018 11:18 pm
Contact:

Re: Guidelines for videos and tutorials

Post by Celica_Supra »

PrzemoF wrote: Wed Jul 31, 2019 10:15 am
Celica_Supra wrote: Wed Jul 31, 2019 8:05 am I would suggest calling out all hotkeys used, at least the first few times if they are used multiple times.
key-mon [1] or other tool showing keys/mouse buttons pressed are really handy for that.

[1] https://code.google.com/archive/p/key-mon/
That looks like a fantastic tool- I think we all have had that experience when the tutorial doesn't call out a hotkey and all of a sudden you're stuck!
freecad-heini-1
Posts: 7616
Joined: Tue Jan 07, 2014 11:10 am
Contact:

Re: Guidelines for videos and tutorials

Post by freecad-heini-1 »

For all Linux users, do you already know Screenkey?
Very helpful for tutorials.
http://www.thregr.org/~wavexx/software/screenkey/
dxp.dev
Posts: 267
Joined: Tue Dec 11, 2018 12:57 pm

Re: Guidelines for videos and tutorials

Post by dxp.dev »

On Mac you have keyCastr
https://github.com/keycastr/keycastr
Find your user.cfg and system.cfg files : Macro_findConfigFiles

Imperial system makes no sense, go metric ! ! !
cookie-cutter
Posts: 1
Joined: Sat Feb 08, 2020 2:18 am

Re: Guidelines for videos and tutorials

Post by cookie-cutter »

1. Versions of Software that the Tutor is using
2. Level of the audience that the Tutorial is made for
3. Clarity of voice and directions of Cursor that is being clicked or any other combo of keys eg. +ctrl or using shift with FreeCAD buttons.
4. Do not say "Do this" or "take this guy" or "and this here" Instead tell us which button on the interface is being used and which follows.
5. Instructions should be clear and precise as if Audience is new to FREECAD
6. Remove or irrelevant comment not relating to the particular Tutorial subject.
7. Would like to see more videos on creating a middle range difficulty 2D floor plan using all of the tools from ARCH and DRAFT and PART
to complete the floor plan.
8. There should be dedicated intro of the user interface of each workbench to enable newbies to understand how to utilise the buttons
in what situations that require it. Some tutorial has too fast a movement and is hard to follow. And some tutorial has zoomed in too
much that the actions on the interface cannot be seen.

Thank you.
Post Reply