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

Failure modes #

  • Spec-sheet — exhaustive mechanical detail that reads as defensive, dates badly, and is hard to skim.
  • Tautological — just a wrapper around a ticket reference that doesn't actually brief anyone.
  • Temporal narrative — anchors the rule to a transition ("previously…", "now that…", "since the migration…") instead of a standing fact. Rewrite as the property the code currently enforces.
  • Over-justifying — escalating to the full Observation → Consequence → Response → Pointer shape for a constraint the reader could've inferred from a one-line label. The paragraph isn't wrong, it's just work the reader didn't need done for them.