Chapter 8: The brief

The chapter ends where this site began.

The right word

Also called Vocabulary, Say precisely what you mean

Using the exact term of the trade instead of a description: "idempotent" for "handles repeats okay", "debounce" for "waits until I stop typing". One word can carry a set of requirements you would otherwise have to spell out, if you know it.

A term points at everything a model has read about it, and you need the name more than the fix. But our worded briefs used the term and stated the rules, so we can't say how much the word alone did. And it is only useful if you can check the result, which means knowing what the word means.

Say it to your agent

“This handler must be idempotent: webhooks are delivered at least once and out of order. Dedupe by event id, and treat any event older than the newest applied to that order as stale. Use those words in the test names.”

The workshop

Name a word, or describe what you mean in everyday language.