Documenting Your Project
Good documentation is part of the project. It's how your work becomes useful to others — and to your future self.
During this bootcamp, every team documents their project on Arduino Project Hub — a public platform where makers and engineers publish step-by-step project writeups that anyone in the world can follow and build from.
Why It Matters
- Your project lives beyond the bootcamp. A well-documented project on Project Hub is a portfolio piece you can share with anyone.
- Others can build on your work. The Arduino community is global. Your writeup might be exactly what someone else needs.
- It forces clarity. Writing down what you did reveals gaps in your own understanding — and helps you fix them.
- It's how real engineering teams work. Logging decisions and steps is standard practice in product development.
How It's Done
1. Create an Account
Go to projecthub.arduino.cc and sign up. Use an account you'll keep — this will be attached to your published project.
2. Start a New Project Early
Create your project at the beginning, not at the end. Give it a working title and a one-line description. You'll refine it as you go.
Click + NEW PROJECT from the Project Hub homepage.
3. Log Each Step as You Work
As you build, add steps to your project writeup in real time. Don't wait until it's finished. Each step should include:
- What you did
- Why you made that choice
- A photo or screenshot if relevant
- Any code you wrote or modified
4. Publish When Done
Once your project is complete, review the writeup, add a cover image, and publish it. A published project is visible to the entire Arduino community.
What a Good Project Page Includes
| Section | What to Write |
|---|---|
| Title | Clear and specific — what does it do? |
| Description | One paragraph: what it is, what problem it solves |
| Components | List the hardware and software used |
| Steps | Each major phase of the build, with photos |
| Code | Paste or link your key code snippets |
| Results | What worked, what didn't, what you'd change |