-
Notifications
You must be signed in to change notification settings - Fork 301
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 four main areas of concern.
- Content of tutorial file
- Coding structure
- Consistency of examples
##Content of tutorial file
All file has content that follows the Markdown syntax and standard 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 suggested to have each heading is presented as a question or a topic like a guide related to the category so readers can select sections revelent to them.
All hyper links are quoted in the text or image with square brackets that refers to the URL's are the bottom of each file to assist maintenance and review of all links. For an 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.
##Consistency of examples
Ensure the selection of examples of code whichever source they come from are revelent to 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) to be done in order to gain additional experience. The more experience the user/developer have, with additional guidance to the rules (from Basic and Advance) may not matter as much but common sense prevails and proper judgement becomes refined or developed considerable (for Proficent/Expert).
rubberduckvba.com
© 2014-2021 Rubberduck project contributors
- Contributing
- Build process
- Version bump
- Architecture Overview
- IoC Container
- Parser State
- The Parsing Process
- How to view parse tree
- UI Design Guidelines
- Strategies for managing COM object lifetime and release
- COM Registration
- Internal Codebase Analysis
- Projects & Workflow
- Adding other Host Applications
- Inspections XML-Doc
-
VBE Events