Zen and the Art of Software Maintenance
Zen and the Art of Software Maintenance
Wisdom is all around us, even if it comes from people who couldn't tell the difference between HTML and C#. One dev shares his thoughts on one such source of inspiration.
Join the DZone community and get the full member experience.Join For Free
[Latest Guide] Ship faster because you know more, not because you are rushing. Get actionable insights from 7 million commits and 85,000+ software engineers, to increase your team's velocity. Brought to you in partnership with GitPrime.
On April 24, 2017, Robert M. Pirsig, author of Zen and the Art of Motorcycle Maintenance, died – one of the best books I have ever read. In this post, we’ll have a quick look at how his book might be useful for software developers without giving away too many spoilers.
The Chase for Quality
In the book, the main character describes how his past self chased the understanding of quality. The problem started with the most basic question: what is quality really? Can you define quality without resorting to synonyms like perfection or virtue? Is quality objective or subjective? If it’s objective, then how come there’s no instrument to measure it yet? If, on the contrary, quality is subjective, then why does it matter so much and how come most people can agree about the quality of certain things?
Obviously, this problem can be easily moved into the software world. How do we define software quality? How do we know whether a piece of software is of high quality? How do we make such software? These are all valid questions, especially for those of you that care about the job you’re doing and the software you produce.
The answer seems to lie in the word that I’ve just used: care. In a sense, quality and excellence are not what defines an object; these are what cause the object to be in the first place. If you care about them when building the product, then you’re building them in the product. If you read the fantastic Clean Code book, this point of view should resemble the one from James Coplien’s foreword:
Quality is the result of a million selfless acts of care—not just of any great method that descends from the heavens.
Form and Function
In some parts of the book, although not as many as the title might suggest, the main character talks about how the motorcycle is built and how to maintain it. He goes on for a while about the parts that the motorcycle consists of and how these parts are built from other parts and so on. This is an important description of what makes up the motorcycle, but it's not sufficient. In a perfect world, it might be even enough to build a motorcycle, but would you be able to maintain it? Would you be able to really tell anyone how it works? Not really. You’d just know the what, the form of the motorcycle, but not the how.
The how of the motorcycle is also referred to as the function of each of its parts. Although to some it might be of little interest, it could actually be considered more important than the form. Imagine that a part of the motorcycle broke on the road. If you know it’s function, then perhaps you know you can get to the nearest mechanic without it. Or you can replace it with something that you carry in your backpack until you get a better replacement. If you know just the form and a part breaks, then either you have that exact part with you or you’re screwed.
These concepts, although maybe understood a little deeper, lie at the roots of the DCI architecture. The dumb data classes are the system’s form. The primary goal of their existence is to describe what the system is. The roles that are then dynamically assigned to these classes are descriptions of what the system does – its underlying function. These two descriptions are related, i.e. they can work together as a system, but are, at the same time, separate. Since a system’s use case is described by the function rather than its form, and the roles are dynamically assignable, the system becomes very flexible, i.e. you can easily replace parts as long as they are suitable to perform certain functions.
You can find more about the all interesting DCI architecture in another great book: Lean Architecture for Agile Software Development.
“Zen and the Art of Motorcycle Maintenance” is not only the title of the book but also a concept coined by the main character’s current self. One of its most important parts is gumption towards the motorcycle maintenance. To preserve gumption, one must avoid what the character calls the gumption traps. Simply put, these are all the things that could disturb you and drag your mind and enthusiasm away from the motorcycle and the problem at hand.
Gumption traps can be divided into two main categories: setbacks and hang-ups. The former are all the external factors that work against your gumption, e.g. you have to do the job all over again because you forgot to put in some part, or you are simply missing the part that you need to finish your job. The latter are more internal factors like boredom or impatience. If you’re willing to do a good job at motorcycle maintenance, you need to have exactly the opposite: interest and patience. If you currently don’t, maybe it’s time for a break.
Software developers obviously have a plethora of gumption traps to fall into. The most common setback is obviously a changing or clarifying requirement. If it means that you will have to rework everything you did in the past weeks or months then, well, here your gumption goes away. The second most common setback that I know of would be the company’s processes. Emails, meetings, approvals, tickets, escalations – for a newbie in the field, it seems like everyone around wants you to do anything but programming. As for hang-ups, these are no different than in the motorcycle maintenance field. Everyone gets bored from time to time when tasked with one of these repeatable, my company-forces-me-to-do-it type of things. And obviously, everyone gets impatient from time to time, when things do not work out as we expected.
The topic of gumption is very interesting, but there’s only so many words one can fit in a single article that people will then actually read. If I got you interested in the gumption traps and fighting them then Zen and the Art of Motorcycle Maintenance and The Clean Coder books are for you.
As already stated in the first paragraph, Zen and the Art of Motorcycle Maintenance is one of the best books that I have ever read. As it often happens with quality literature, the topic does not necessarily have to be of in your area of expertise and you can still find a ton of wisdom and useful advice in there. Therefore, set aside some time every day and read, read, read. It will make you a better programmer and a wiser person.
Published at DZone with permission of Grzegorz Ziemoński , DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.