Page 1 of 3

Guidelines for videos and tutorials

Posted: Wed May 08, 2019 7:16 am
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.

Re: Guidelines for videos and tutorials

Posted: Wed May 08, 2019 9:46 pm
by sgrogan
Videos should never auto-start.
After starting there should be a way to quit/pause.

Re: Guidelines for videos and tutorials

Posted: Sun Jun 09, 2019 1:39 pm
by wandererfan

Re: Guidelines for videos and tutorials

Posted: Wed Jul 31, 2019 8:05 am
by Celica_Supra
I would suggest calling out all hotkeys used, at least the first few times if they are used multiple times.

Re: Guidelines for videos and tutorials

Posted: Wed Jul 31, 2019 9:57 am
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.

Re: Guidelines for videos and tutorials

Posted: Wed Jul 31, 2019 10:15 am
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/

Re: Guidelines for videos and tutorials

Posted: Wed Jul 31, 2019 4:40 pm
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!

Re: Guidelines for videos and tutorials

Posted: Mon Nov 25, 2019 4:26 pm
by freecad-heini-1
For all Linux users, do you already know Screenkey?
Very helpful for tutorials.
http://www.thregr.org/~wavexx/software/screenkey/

Re: Guidelines for videos and tutorials

Posted: Sun Dec 08, 2019 2:37 pm
by dxp.dev
On Mac you have keyCastr
https://github.com/keycastr/keycastr

Re: Guidelines for videos and tutorials

Posted: Sun Feb 09, 2020 2:13 am
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.