Chapter 19: Being Specific

Mull It Over

  1. Is a poor specification better than no specification at all?

A factually incorrect or painfully out-of-date specification is definitely worse. It will send readers down a blind alley and waste a lot of their time. The false information it contains could easily lead to broken code that will cost a lot of time, energy, and money to fix later on.

If a specification is ambiguous or misses important information, then you’re hoping that the readers are experienced enough to recognize the problem and interpret the information carefully. Hopefully they’ll all make the same set of assumptions about the missing information. A specification should really stand on its own and not require the intuition of its readership. ...

Get Code Craft now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.