Baker's Demo Project

Here is my example project. This should give you a good idea of the layout and format for your documentation.

Record your research and background information in this section

List the parts, materials, tools/equipment you need. Aim to make this list as complete as possible, remember your gold standard here is that anyone should be able to follow this Instructable and make a completely functional product.

Bill of Materials

1. Raspberry Pi Pico W
2. 4x Momentary Push Buttons
3. 500mm NeoPixel LED Strip
4. Hookup Wire

Tools & Equipment

1. Soldering Iron
2. 3D Printer
3. Side cutters
4. Wire Strippers

Here is an example wiring produced using the Cirkit Designer App. You can have a look at it in the app > HERE <

Follow THIS TUTORIAL to get started using Cirkit.

NOTE: The tutorial shows an Arduino Microcontroller. We're using RPi Pico, but all the things to click on are the same. Just a different board. 😉

Add as many steps as you need to document your project. Here are some tips for this:

1. Balance the number of steps with the detail required. You don't want really long, detailed steps OR hundreds of tiny steps. In general - the fewer the better.
2. Make each step as complete as possible - everyone hates instructions where new items, materials, etc. are introduced but not mentioned previously!
3. Keep your writing to the point. I'm marking on clarity, accuracy and how well you communicate what's needed. NOT on length.
4. Use the text editing features to highlight key information and keep things visually interesting. See the examples below.

Block Quotes

This is a block quote. Use it to highlight important information or provide context to the reader.

Links

Use links to sites to document references or resources that people may need.

Example:

🔗 Button debouncing and counting with interrupts

Code Blocks