A short introductory video for Arduino forum

Many newbie on this forum struggle posting their questions/problems properly.

A short video explaining how should they post and what are the necessary information they should must add to their post could be helpful for newbies and forum members.
@moderators

3 Likes

Good idea, dinosaur generation (me included) prefer written instructions but mainstream is probably video.. :expressionless:

3 Likes

I think many of us virtually always ask for things like:

  • Describe what the project/system is supposed to do
  • In case of a problem: describe what it actually does, i.e. how is it misbehaving
  • A schematic/wiring diagram
  • Clear photographs of the physical system as built
  • Details on components used (which Arduino, which modules etc.)
  • Actual code used, between code tags
  • A minimum version of the setup/code that demonstrates the problem and with all extraneous/unrelated hardware and code removed

Of course, some of these items are specific to certain categories of problems, but I think if the above would be covered in all new threads, it would make problem solving faster in about 90% of the instances.

1 Like

hm I guess for some youngsters you have to make a series of 20 pieces of 10 seconds tik-toks.
But be aware these tik-toks must be so funny that they stay at least for 10 of them.

maybe montages of what NOT to do (e.g. "primitive pete" from shop class)

I think Primitive Pete works best by showing the right way, and then a problem with doing it wrong.

Maybe stepping through How to get the best out of this forum and showing the contrasts and costs of doing it wrong: distraction and lost helpers.

I find ESR's How To Ask Questions the Smart Way snarky enough to be funny.

3 Likes

Indeed.

Maybe include the
"this is not a code writing service but a help forum"
angle to dispel any delusions from the start.

Along with the angle of not writing all your code before you even run it, but build up with a new component, test & debug, before adding the next part.

Some stuff that might be important

  1. Select category.
    Specifically mention:
    • Not to use "Uncategorized" although this might interfere with the spam-catcher function.
    • IDE categories are specifically for problems with the IDE and not with code.
    • Maybe add that any board detection/upload problems should go in the Avrdude, stk500, Bootloader issues - Arduino Forum category (that thing needs to be renamed as was suggested in the past).
    • That there are all kinds of Nanos and Unos
  2. Catchy title.
    Add note:
    • "My Uno does not work" is a crappy title
    • Do not try to squeeze the full error message in the topic title.
  3. Description of what you expect to happen and what actually happens.
  4. Hardware
    • Specify board and if possible provide link to what you bought. Not needed if you post in a board specific category.
    • Provide links to other boards / module that are connected.
    • Provide a schematic / wiring diagram. Photo of pen/paper is OK.
  5. Code
    • Autoformat code in the IDE before posting.
    • Use code tags when posting.
    • Specify libraries used so helpers don't have to guess and possibly find the wrong one.
      If from github, provide URL.
      If from library manager, name and author.
  6. Although not always relevant, IDE version used.
  7. You might want to mention some settings in the IDE
    • Verbose output during compilation; problem with ESP boards is that that output can be extremely long and might not fit in the 120,000 character limit.
    • Verbose output during upload.
    • Enable verify after upload.
    • Warning levels; with that you might want to mention that some warnings are from the Arduino core and can (usually) be ignored.

That's what I can think of at the moment. I know that the above might go a little further than the intended purpose of the video.

Note:
As the forum does evolve over time, you might want to mention that the video was made at a specific date and things might have been changed.

1 Like

newbies come here where they need to type in their questions and read textual answers… yet we can’t get most of them to read the best practices established by the community… not sure a video would get more clicks than the link to those best practices but I guess it’s worth a try.

It needs to be short and entertaining so you can’t touch all the topics. I would insist on

  • establish the purpose of the forum (get support and advice for projects and learn stuff)
  • you are joining a community, treat it as you would expected to be treated
  • Introduce yourself (in the right category when there is one)
  • Don’t post your question without getting a feel for the forum, read some other posts, research if your question has already been asked
  • follow best practices rules when posting, no snippets, use code tags, follow netiquette, provide as much information as possible (circuit, code, links to components,…)
1 Like

Unfortunately this is not a cultural icon outside the U.S. and to a U.K. person, and I suspect many other places, it means nothing.

It is a bit like the Blue Ox reference in the original Colossal Cave text adventure, outside the U.S. no one "got it".

@Delta_G I think this advice should also be applied to the introductory video idea. Don't expend a great effort trying to make a slick video that tries to cover every point while being funny and entertaining at the same time. Keep it small and simple to begin, no more than 3~5 points, and see how that is received. Adopt an agile approach, if you know what I mean.

1 Like

@Delta_G
I don't think it's useful to retell the whole forum guidelines in a voice.
Use video for what it has an advantage over text - to show what is difficult to describe in words.
I would cover in it - how to insert code correctly, how to copy a sketch and error messages from the Arduino IDE, how to add pictures and how to edit posts...

1 Like

The mechanic analogy without the car is not bad.

What about opening up with either a black closed box or a pet rock? The person with the object is adamant about there being a problem and they need help. However, no one else can see anything wrong.

The Video idea sounds good , but I usually don't want to see the Arduino get Unboxed so I drag the progress bar up to where the real stuff is done.

I would suggest small short Videos.

whatever you do, keep each point short, succinct

if something needs more time, put it nearer the end,

Kids today watch hours of videos to learn simple things. They are forced to do it in schools and they do it by choice for things they are interested in. They are masters at skipping over stuff they already know and pulling out just enough to answer the question.

Certainly it should try to be a good quality, entertaining, etc but a video about “How To Get the Best Out Of The Forum should actually cover the material in the doc. Given links to the doc and the vid, a person should be able to choose either and then buzz through to get the info they need.

Another benefit from following the guidelines in writing the question is that describing the problem well enough for helpers to help often leads to answering the question for yourself.

if a person posts his/her problem on the forum. it means he/she is interested in these types of things.
i don't think a simple 2-minute video has to be full of funny things.

tagged some more peoples for suggestion

@Wawa @jim-p @Deva_Rishi

1 Like

If I understand you correctly you are asking permission to create accounts in order to have a fake abusive conversation as source material for a tutorial, is this correct?

I'm not against allowing established contributors a second account for testing or whatever but I find the proposed use of a second account concerning, so no, as proposed, I decline your request. Perhaps I misunderstood you, so feel free to try and persuade me.

I suggest you ask for volunteers to join a private discussion, which you can create, and have your mock abusive conversation there. Really though, I think this is not a good approach.

For reference I don't have a second account, although I know some moderators do.

Ah! There's the thing, I don't call it that, so I didn't recognise what you meant.

My suggestion is still to do this in a PM with some volunteers.

Absolutely do not do that, for the reasons you already know.

TBH I think you should consider which particular behaviours you wish to highlight and write a script around those. I suggest you aim for 3 things.