The Changelog - v0.2.0
It's the week before Thanksgiving π¦ and looking to wrap up a few things before the holiday season kicks into overdrive (already stressing about gift-giving! π₯²). I digress...
In this changelog, I'm changing the way I go about reading documentation and reminding myself of the importance of clean code. Also, highlight some tools I found this week and ones I enjoy using consistently. Lastly, a new project I'm working on to learn a new framework (hint: terminal π» + Python π).
Here is the latest release! π Version 0.2.0 π.
RTFM π€¬ β‘οΈ π
When I stumble upon a β¨ new package or library β¨ that I think will solve my problems my next steps are as follows:
- Open documentation ‡οΈ
- Read the intro ‡οΈ
- Try the example (hopefully they have one π€) ‡οΈ
- Then immediately dive into whatever problem I am trying to solve that led me to the package in the first place ‡οΈ
I thought that was a good strategy, but after reading a recent blog post my view on reading documentation has changed.
π Read:
-
I stumbled upon this post by Aaron Franics πββοΈ that developers should read the docs like a book because it can help:
- Build a "mental map" π§ πΊ of the tool's features and functionality.
- Prime the subconscious to recognize new context and patterns π§ββοΈ.
- Extract more details. π¬
- Make stronger connections πͺ’ to other other sources (eg. YouTube π₯, Podcasts π, Courses π etc.).
I'm trying to implement this strategy into the next framework I'm working with Textual
I appreciate well-written code as much as the next developer and it is important because writing clean code helps to reduce cognitive load.
π§ "People can typically hold up to 5β7 separate pieces of information in their short-term memory;..."
I think I hold less in my head π΅βπ«, so I try to adhere to the best practices mentioned in this post to make functions small, single purpose, and return as often as possible π«‘.
One of my favorite writers on the web Trung Phan, writes about Brian Eno - the man behind the Windows 95 startup sound π€―. π¨ 11 Creative Lessons from Brian Eno
π£ "The idea that anything βyou donβt have to doβ is βartβ is a universal. It permeates everyday life across cultures and time. It clearly serves a purpose. It gives us comfort. It is a way to express ourselves. It is a form of communication. It helps us bond. These are all crucial aspects of the human experience. If βartβ didnβt achieve any of these goals, our species wouldnβt have been making such stylistic decisions for thousands of years."
π§° Tools:
-
πΌ tldraw whiteboard with new AI capability to turn any sketch into a working prototype.
-
β¨οΈ Cursor - AI-powered IDE. A fork of VSCode.
-
π¦ + π = [Mockaroo] is a tool for generating mock data quickly. I even wrote a Python library around its API for those Django and Python web developers in mind. Check it out here.
β¨ New:
-
Started a new book A Philosophy of Software Design.
-
Started a new project that uses Textual and Yahoo! Finance API to build a stock screener. The goal of this project is to learn more about the Textual framework and apply some of the lessons from Aaron Francis's article about reading the documentation like a book.‴οΈ.