Showcase and Build Guide

Author The Listener Topic Bassilisk First published Last updated 3 min read

Suggest a correction

Every build has a Showcase for what you made. Add an optional Build Guide when you want to document how another builder can reproduce it. Each editor holds a different part of the same build.

Why it matters

A photo of a finished speaker answers a different question from its cutting files and assembly steps. The Showcase explains the result. The Build Guide records the information needed to make another one.

You can share a build without writing a guide. You can also assemble guide content while continuing to work on the Showcase. Saving one editor does not overwrite the other editor's content.

How it works

The Showcase

Use the Showcase editor for the title, category, project status, hero image, description and gallery. Add specifications and measurements to explain the build's technical details. Media coverage, competition history and the source of a remix also belong here.

Keep the description focused on what you built and the choices behind it. A gallery can show both the result and process photos. Put ordered instructions in the Build Guide's steps when another builder needs to follow them.

The optional Build Guide

Save a new build before opening its guide editor. The Build Guide holds Tools required, Known issues, Files & resources, Bill of materials and Build steps. It also records your costs, currency, build year and country.

Use the bill of materials for parts, quantities and what you paid. Use files and resources for plans, models, documentation or external resources. Record problems and workarounds under known issues so another builder can account for them.

Under Guide visibility, the control Show this build guide on the build page determines whether the guide sections and reviews are shown. Saving with this enabled requires a bill-of-materials part and a total cost. Publication still follows the build's review process.

What guide levels mean

  • Draft guide: instructions are being assembled. Readers should not treat it as ready to build from.
  • Partial guide: useful information exists, but steps, the bill of materials or files are missing. Readers need to identify those gaps before starting.
  • Full guide: enough information exists to reproduce the build. Check the tools, parts, steps, files and known issues together.

These labels describe the guide's completeness. The project status, Prototype · In Progress · Finished, describes the physical project. The publication status, Draft · In Review · Published · Needs Changes, describes review. A finished project and a full set of instructions are separate things.

What to check

Read your Showcase as someone seeing the project for the first time. Then read the guide as someone preparing to build it. Check that the parts named in the steps appear in the bill of materials and that the required files are present.

For example, enclosure photos and a response curve belong in the Showcase. Panel dimensions, cutting files, assembly order and parts quantities belong in the Build Guide. Each contributes different information.

Common mistakes

  • Treating a Build Guide as mandatory before sharing any build.
  • Putting every assembly instruction into the Showcase description instead of the guide steps.
  • Reading Published as proof that the physical project is Finished or that its guide is complete.
  • Assuming that saving guide content immediately changes the public build.

Read Publish your build for the review workflow and Licences for guides and files for reuse terms.

First published

Last updated

The author maintains this document. Contributors can suggest corrections.

Discussion

No linked discussion yet. Ask a question or add context from your own work.