# Build log template: how to document a build people can follow

**URL:** <https://hacktronauts.com/t/build-log-template-how-to-document-a-build-people-can-follow/18>\
**Category:** DIY Synths & Builds\
**Created:** [October 5, 2026, 8:16pm UTC](https://hacktronauts.com/t/build-log-template-how-to-document-a-build-people-can-follow/18 "2026-10-05T20:16:58Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Pilkafa](https://hacktronauts.com/letter_avatar_proxy/v4/letter/p/cab0a1/32.png) [@Pilkafa](https://hacktronauts.com/u/Pilkafa)\
**Post date:** [October 5, 2026, 8:16pm UTC](https://hacktronauts.com/t/build-log-template-how-to-document-a-build-people-can-follow/18/1 "2026-10-05T20:16:58Z")

</div>

A good build log lets someone else repeat your project, or learn from the parts that went wrong. You don’t need perfect photos or a long write-up. Copy the template below into a new topic in this category, and update it as you go.

```auto
## Project summary
What is it, and what does it do? One or two sentences.

## Goal and scope
Why you're building it. What it won't do.

## Parts list
Part, value or model, quantity, where you got it.

## Tools needed
Soldering iron, scope, programmer, anything unusual.

## Schematic and layout
Link the files or post an image. Name the tool you used (KiCad, a pencil, etc.).

## Firmware
Link to the repo (GitHub or similar), the branch or tag you used, and the toolchain. Do not upload binaries here.

## Build steps
Number the steps. Add a photo and a caption for the tricky ones.

## Testing
How you checked it works. Measurements, audio clips or a short video.

## Problems and fixes
What went wrong and what you did. This is often the most useful section.

## Status and next steps
Working, half-done, abandoned? What would you change next time?

```

**Tips**

- Post early and add updates as replies. It is fine if it isn’t finished.
- Tag the topic with what applies, for example a board such as Arduino, Teensy, Daisy or ESP32, or a format such as Eurorack, kit or PCB.
- Keep the source files in a repo and link them, so people can fork and fix them.
- Check licences on any designs or code you reuse, and say which licence yours is under.