My Nix configuration. Enter at your own risk.
dotnix modules home skills code-comments code-comment-escalation.md
773 B
Markdown
at main

Escalate only when intuition won't bridge the gap #

Some constraints aren't derivable from domain sense — a fact about the world that a reader can't be expected to already hold (an external system's quirk, a spec's parsing rule, a platform limitation). For those, and only those, spell out the piece that's genuinely missing:

  • Observation — the non-obvious fact about the world.
  • Consequence — what breaks if you do the naive thing instead.
  • Response — one imperative: what this code does about it.
  • Pointer — a ticket, commit, or search term for the full story.

Use as many of these as the gap actually requires — often just Observation plus Response is enough; save all four for constraints a reader has no way to intuit on their own.