monospace,
@monospace@floss.social avatar

"Tests provide the only reliable documentation of design. The story they tell remains true long after paper documents become obsolete and human memory fails. Write your tests as if you expect your future self to have amnesia. Remember that you will forget; write tests that remind you of the story once you have." (Sandi Metz, "Practical Object-Oriented Design")

underlap,
@underlap@fosstodon.org avatar

@monospace Tests, at least partially, answer the question "What does this code do?", but don't necessarily help answer the question "Why was this code written?", something that a design document can describe and which will continue to remain true because it's a description of the past. No?

monospace,
@monospace@floss.social avatar

@underlap Good point! A valuable practice I’d recommend for this purpose are Architectural Design Records (ADR): https://adr.github.io/

underlap,
@underlap@fosstodon.org avatar

@monospace Yeah, writing down the rationale for significant design decisions is a good idea.

  • All
  • Subscribed
  • Moderated
  • Favorites
  • ruby
  • DreamBathrooms
  • everett
  • InstantRegret
  • magazineikmin
  • thenastyranch
  • rosin
  • GTA5RPClips
  • Durango
  • Youngstown
  • slotface
  • khanakhh
  • kavyap
  • ngwrru68w68
  • tacticalgear
  • JUstTest
  • osvaldo12
  • tester
  • cubers
  • cisconetworking
  • mdbf
  • ethstaker
  • modclub
  • Leos
  • anitta
  • normalnudes
  • megavids
  • provamag3
  • lostlight
  • All magazines