docs: start a findings log - #19
Merged
Merged
Conversation
The good details evaporate. Nobody remembers in three months why the evidence fact pointed at the wrong person, and that is exactly the kind of thing an honest write-up is made of — or the kind of thing you relearn the hard way. One entry per discovery: what happened, why it matters, where to look. If it surprised nobody it is not a finding, it is a changelog line. Seeded with what phase 1 produced, including the parts that were mistakes: two generator bugs the validator caught and code review would not have, Portuguese grammar leaking into the domain model, a downside written into an ADR and then ignored for days, and half a dozen GitHub behaviours that only show up when you trip over them — a ruleset that was inert on a private repo, a branch rename that closes open PRs, a merge box that freezes the commit message when the page loads.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A place for what surprised us, so it survives long enough to be written about.
Why
The details that make a write-up worth reading are the ones that evaporate
first. Nobody will remember why the evidence fact pointed at the wrong person,
or that a
PREPOSICAOmap once sat inside the case generator. Those are theentries; the successes mostly document themselves in the ADRs.
Format is deliberately strict: what happened, why it matters, a link. If it
surprised nobody, it is not a finding — it is a changelog line, and it does not
go here.
What it starts with
Everything phase 1 produced, including the parts that were mistakes:
correct code
days — documenting a cost feels like addressing it
that was inert on a private repo while showing as active, a branch rename that
closes the PRs whose head it renamed, a merge box that freezes the commit
message when the page loads
size behind it
It also carries two ideas the work threw off: an automated detective as an
eval — an agent that plays a match with only what a player can see, proving in
practice what the solver proves structurally — and a comparison of open-weights
models served from a Brazilian cloud against the adversarial suite, in
Portuguese.
Cost of keeping it
One line per discovery, written when the discovery happens. The project's own
principle is that a document which does not pay rent is debt — this one pays by
being the skeleton of the article and by stopping the same mistake twice.