Keep a build journal

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

Suggest a correction

Use the Build Journal to post dated updates after publishing your build. Add a title, notes and optional photos. Updates appear directly in the journal, and you can return to edit or remove them.

Before you start

Your build must already be published, and you must be signed in as its author. Open the update editor for that build. The journal is for changes, fixes and progress after publication: a crossover revision, a repair, or a report after several months of use.

Decide which event the entry records and when it happened. Each update needs a title and entry date. The written body and photos are optional. You can add up to ten photos in PNG, JPG or WebP format, up to 8 MB each.

The update editor is read-only while the build is In Review. Resolve or withdraw that build submission before using the editor to change the journal. See Publish your build for the submission workflow.

Steps

  1. Enter an Update title. Keep it within 200 characters and name the change or result. A title such as “New crossover revision” tells readers more than a general progress label.
  2. Set Entry date to the date the work happened, or today for a current update. This date appears on the journal entry and determines its place in the timeline.
  3. Write the update text if the title needs explanation. Describe what changed, why you changed it and what you found. Include enough context for someone who read the earlier version of your build.
  4. Add photos when they help show the work. Drag them into the order you want and add captions where useful. Check that each image belongs to this update and explains something the text refers to.
  5. Check the date, title, text and photos, then choose Publish update. This publishes the journal entry directly. It does not create a draft entry waiting for the build-review queue.

What happens next

Readers see the entry in Build Journal on your build. Entries run newest first by entry date. The build page shows recent entries, with the full journal available for the rest.

Each entry shows its date and title, followed by any written content and photos. Captions appear with the images, and readers can open photos for a closer look. An edited entry can show an Edited label.

To make a correction, select the existing entry in the update editor or use its Edit link in the journal. Change the title, date, text or photos and choose Update. The saved changes appear on that entry. Changing its entry date can move it within the timeline.

To remove an entry, open it for editing, choose Delete and confirm. The entry is removed from the journal. Check that you have selected the intended update before confirming.

A journal entry records news about the project. Posting one does not replace the Build Guide's instructions, resources or measurements. If a change affects those sections, edit them too and follow their build-review workflow.

Common mistakes

  • Posting a file revision in the journal while leaving the old file attached to the Build Guide. Replace the resource as well.
  • Using today's date for old work without checking where the entry will appear.
  • Writing an update as though it were a private draft. The publish action makes it a public journal entry immediately.
  • Deleting an entry when a small correction would preserve useful history. Use the edit action when the event itself is still relevant.

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.