DEV Community

Discussion on: Software tests as a documentation tool

Collapse
 
evanplaice profile image
Evan Plaice

I agree 100%

My 3 general rules for digging into an unfamiliar codebase are:

  1. Documentation is the best documentation except when it's incomplete and/or out-of-date.

  2. The test suite is the next best thing. In some rare cases, a high quality test suite can be even better than the docs.

  3. When all else fails, start digging into the history and become a code archaeologist.