This week we look at API Design or chapter 8 of Code That Fits in Your Head by Mark Seemann.
We talk about two concepts this week
- poka-yoke or the idea of mistake-proofing
- Writing for our readers
Mark includes a Hierarchy of Communication
- Guide the reader by giving APIs distinct types.
- Guide the reader by giving methods helpful names.
- Guide the reader by writing good comments.
- Guide the reader by providing illustrative examples as automated tests.
- Guide the reader by writing helpful commit messages in Git.
- Guide the reader by writing good documentation.
We'll be discussing these ideas and more this Thursday at 7 pm eastern in the free companion discussion.
You can sign up for free at BookClub.dev.
I hope to see you there and until next time happy reading.