Tutorial Guidelines

The tutorials provided for Rubberduckers have been selected to follow this format for ease-of-use and readability.

These guidelines here are broken down into three main areas of concern.

• Content of tutorial file
• Coding structure
• Consistency of examples

Content of tutorial file

All files have content that follows the Markdown syntax and standards Github has adapted as best practice for providing documentation. The layout of each file will vary depending on the depth and breadth of each category.

A recommendation is to have each heading presented as a question, or a topic like a guide related to the category, so readers can select sections relevant to them.

All hyperlinks are quoted in the text or for images with square brackets that refers to the URL's are the bottom of each file to assist maintenance and review of all links. For example, if a hyperlink is broken due to someone no longer having the website, the reviewer can find the link quickly at the bottom of each file.

Coding structure

To create inline spans of code, simply wrap the code in backticks (). Markdown will turn myVBA` into myVBA code.

Offer to the reader examples using the difference between good code and bad code, explaining which part of the code is good or bad with a reason why in a logical flow. Be mindful which of the five stages of skills acquisition is involved.

Consistency of examples

Ensure the selection of examples of code, irrespective of source, are relevant to the Readme-Introduction.md context. The Dreyfus model of skill acquisition are skills made into segments. Each segment is really a priority of which tasks or categories (lowest to highest or more complex) are to be done in order to gain additional experience. The more experience the user/developer has, with additional guidance to the rules (from Basic to Advanced) may not matter as much but common sense prevails and proper judgement becomes refined or developed considerably (for Proficient/Expert).