Field Notes

Short notes on building dependable software.

Keeping a useful changelog

A changelog works best when it explains the effect of a change. Group related updates, describe the outcome, and keep release dates visible. Small entries written alongside the change are easier to maintain than a long retrospective.

A small backup routine

Choose the files that would be difficult to recreate, keep more than one copy, and test restoration. A backup is useful when its contents can be recovered with a documented procedure.

Reading error messages

Start with the earliest relevant error and record the inputs that produced it. A small reproducible example often reveals more than a large log. Keep the example alongside the fix for future reference.