field notes

Writing

Short notes from real engineering work: one decision, one incident, one reversal at a time. Each one names the shape of the problem, the tension that made it hard, the decision, and what it cost. The internals stay out — the codename is the hint.

If you have five minutes rather than an afternoon: the three case studies condense this material to one problem, one decision and what the decision cost. The notes below are the record those studies cite — and the projects the codenames belong to are on the front page.

source notes/ · 252 notes · 10 codenames · newest first · atom feed

All field notes

filter by theme · 244 total

a place to put a question

A system that helps write its own documentation produces confident prose about things it does not know. The failure is not a lie. It is a guess that is well formed and sits in a document that is otherwise correct, which is the hardest kind…

read

one owner per claim

Two registers had grown to cover the same ground. One was meant to hold only claims that cut across the whole estate; over time it had acquired role definitions and storage rules that were true of exactly one system, because that was where…

read

no, and not yet, are different answers

A record field that can hold only true or false cannot hold "nobody has decided this". Written as a yes-or-no, an open question reads as a no, and a register full of noes looks like a system that considered everything and declined, which is…

read

the document acquired a reader

Turning a document into something a build can verify gives it a machine reader, and a machine reader is a new place to be wrong. The claims were prose — which components connect to which, what has to sit between them, the chains those…

read

the register nobody edits

A document that lists every decision a system rests on can only be trusted if it is complete, and a complete register written by hand costs a person's attention in proportion to how much has been decided. That cost is paid exactly when…

read

the history is also reviewable

Code review looks at what changed. A second kind of review looks at how it changed, across a stretch of the mainline, and asks whether the record can be read by somebody who was not there. That review found four classes of drift and no…

read

consent a customer can actually read

The registration form is where a platform's promises become a customer's problem, so it is the wrong place for a single combined checkbox. The change that landed separated the agreements from the marketing permission, linked each required…

read

one answer instead of a wall of denials

A staff dashboard has to know what the person in front of it may see before it renders anything. The direct way is to ask about each protected area and see which answers come back. Every one of those questions is legitimate, and the browser…

read

the flake was in the isolation, not the code

Two failures in the same period, and neither was a defect in the product. A totals assertion failed once in a run and passed on the retry. A later step in an unrelated scenario answered not-found for a row the test had just created. Both…

read

method

What a field note is

Not a changelog entry and not a repository summary. One decision, one incident, one reversal, or one hard-won invariant — the thing an engineer would tell you at a whiteboard.

shape
What made the problem genuinely hard, before any solution appeared.
tension
The two things that could not both be true — stated precisely, because that is the part that transfers.
decision
What was chosen, and what it cost. Cost is the credibility; a decision with no cost attached has not been described.
ceiling
A codename, a theme, and a class of problem — never a hostname, a parameter, a version or a vendor. Under the disclosure rules the hint is the category, not the instance.

Prefer records with dates and root causes? Those are on incidents. Live numbers are on stats.