refactoringnaming.mdSettings
refactoring, updated 30 Jul 2026

Naming: The Cheapest Documentation in the Hive

Placeholder prose. Every role in the hive has a plain name, and nobody needs a glossary to know what a guard does. The opening section sets up the analogy and states the principle in one sentence.

Second paragraph of placeholder body copy. It names the reading cost of a bad name and why it compounds.

The name that needs a comment

Placeholder lead-in to the code sample below.

hive/util.ts
// number of bees currently outside the hive
let n2 = 0;

// vs.
let beesInFlight = 0;

You will read this name a hundred times and type it four; optimise for the hundred.

Say what it is

Closing placeholder paragraph. It restates the rule, concedes the genuinely conventional short names, and hands off to the next article.