01. Prepare
Describe the setup, inspection, or prep work needed before any irreversible step begins.
Call out the condition that tells you the setup is ready.
One-line project summary: what it is, what problem it addresses, and why it matters.
Use this section to explain the project context, what prompted the build, and the main constraint or goal that shaped the work.
Briefly describe what makes this version interesting compared to earlier ideas, references, or standard approaches.
Reflection: Add the practical takeaway here. This works well for one short warning, one useful build note, or one lesson you want people to remember before they copy the process.
Use this section for the tests, references, and constraints that informed the design. It should answer what you checked first and what changed because of that research.
Document the variables you compared, the assumptions you started with, and what the results told you.
Conclusion: Summarize the strongest result from your testing here so the reader understands what decision carried forward into the build.
Use this area for sketches, CAD screenshots, parameter changes, layout iterations, or other design development steps.
Keep the emphasis on what changed and why, not only on what software was used.
Reflection: Use this callout for a workflow lesson, design shortcut, or note about a toolchain limitation worth remembering for the next version.
Use this table for the core parts, stock, and tools required to reproduce the project.
| Item # | Item | Purpose | Notes | Format | Status |
|---|---|---|---|---|---|
| 1 | Primary material | Main build element | Any sizing, sourcing, or handling note | Sheet, print, part, or stock | Used |
| 2 | Secondary material | Support or assembly function | Optional notes about quality or alternatives | Part or tool | Used |
| 3 | Measurement or finishing tool | Verification or cleanup | Include any setting that mattered | Tool | Used |
Use the step sequence below for the physical fabrication or assembly flow. Keep each step focused on a concrete action plus the one detail that matters most.
Describe the setup, inspection, or prep work needed before any irreversible step begins.
Call out the condition that tells you the setup is ready.
Explain the first real making action, including the tool or setting that matters.
Add a warning if this step creates the most common mistake.
Show how you verified progress before continuing.
Use this space for fit tests, continuity checks, alignment checks, or similar validations.
Describe the last physical steps needed to complete the object and clean up the outcome.
Note what you inspected before declaring it done.
Reflection: Use this callout for the practical fabrication takeaway: what made the process easier, what repeated cleanly, or what you would change before the next run.
Use this section when the project includes firmware, software, or digital tooling that deserves its own explanation.
Document the environment, board or platform selection, upload method, and any pin mapping, calibration, or dependency notes.
State the IDE, toolchain, or runtime used for the project.
List the board settings, libraries, or configuration values that must match.
Explain how you confirmed the code or behavior was working correctly.
Use this closing section to summarize the result, what worked, and the limitations that still remain.
Reflection: End with the broader takeaway: where this method is most useful, who it helps, or what kind of future project it now makes possible.
# Replace with project code
def setup_project():
print("Template ready")
if __name__ == "__main__":
setup_project()