You Don’t Have to Write Perfect Code. It’s Okay to Be Good Enough | by Guy Erez | Jun, 2022

Perfection comes at a price

Photograph by Ryland Dean on Unsplash

Perfectionism. These days it’s usually displayed as a badge of honor.
A lot so, that it’s thought-about a “good” unfavourable high quality to say throughout interviews, because it tends to be related to diligence and laborious work.
Perfection, nevertheless, comes at a price.

You could be scratching your head proper now. Motherhood? Code?
Don’t fear, it’ll all make excellent (pun supposed) sense in only a second.

The “Good Sufficient Mom,” was a time period coined by the famend pediatrician and psychoanalyst Donald W. Winnicott. Its essential concept is that aiming to be an ideal mother or father tends to introduce unintended dangerous behaviors. Thus the search to be an ideal mother or father backfires, inflicting extra hurt than good to each the mother or father and their youngster.

While you consider it, it makes excellent sense. However in case you occur to be a mother or father of a new child youngster, it could be laborious to just accept. In spite of everything, it’s a very powerful factor you’re going to do in life — elevating an precise human being that’s 100% depending on you. However you understand what it’s like. When the stress mounts up, we started to be extra irritable, cease pondering issues by way of, and all of those feelings are communicated again to your youngster.

That’s undoubtedly a fascinating topic, however I’m not right here to speak about parenting.
The aim of this fast psychology lesson was as an example how perfectionism, even when utilized to a very powerful issues in life, like parenting, is the fallacious technique to go.

So, what does it imply to be a “ok” developer?

What does it imply to jot down “ok” code?

Let’s start with first rules, and ask ourselves — What’s the aim of writing code?

Photograph by Markus Winkler on Unsplash

Some deal with code as a type of artwork. They try to jot down elegant, stunning code that conjures up others. I’m all for elegant code, however that’s not its final aim.
The true aim of writing code is to resolve issues.

Even so, we don’t simply need to clear up issues, we need to clear up them properly.
We don’t simply need to construct a product that works, we would like it to be a top quality product. Nevertheless, sooner or later, spending extra time making the code somewhat extra excellent, produces no tangible outcomes.

Furthermore, if we’re spending a lot time perfecting our code, the dearth of tangible outcomes is the least of our issues. Perfection, laudable as it could be, comes with a steep price ticket.

Photograph by Elisa Ventur on Unsplash

There’s one downside with perfection, and it’s a giant one — perfection is subjective. Most individuals can agree in the case of really terrible code. However in the case of writing excellent code? Everyone’s acquired an opinion.

“It’s best to extract these traces right into a operate”

“You have got too many features”

“This could belong in a separate class”

“That doesn’t justify a separate class”

“Add express parameter names when instantiating objects”

“The code is simply too verbose, take away express parameter names”

“It’s important to add feedback in key areas”

“It’s best to by no means add feedback”

“It’s best to not often throw exceptions — return a response object with standing: failed”

“If one thing doesn’t work — all the time throw an Exception”

“The code isn’t OOP sufficient”

“This doesn’t justify OOP’s coupling — use a extra purposeful method”

The record goes on and on. It turns into much more troublesome if the feedback above all got here in a single PR from completely different teammates. Within the face of so many conflicting opinions, is it even potential to make the code excellent? In all probability not.

Since there isn’t a clear normal for perfection, engineers may spend hours, even days, considering trivia. That may simply result in overthinking and finally even burnout.

So what’s the worth of perfection you ask?

Burned-out engineers who don’t make progress on their duties.
Capturing for perfection means lacking our goal — Being efficient at fixing issues.

Photograph by Felicia Buitenwerf on Unsplash

With the intention to clear up issues successfully, we have to strike a stability between code high quality and truly getting issues carried out. So as to take action, we have to discover the purpose of diminishing returns. The place the place spending extra time optimizing code high quality, won’t produce a greater consequence, and may even make us much less efficient total. We have to assemble our personal definition of “Good Sufficient” code.

The definition of “Good Sufficient” code have to be decided in accordance with your distinctive wants. Some companies may prioritize transferring quick, so the usual won’t be as excessive. Different companies may require a sturdy infrastructure the place each small mistake may spell catastrophe.

As soon as we’re clear on our enterprise’s distinctive priorities, we have to decide our coding tips. It’s greatest carried out on the stage of your complete R&D division, so as to promote simpler collaboration. However on the very least, it must be decided on the stage of your crew.

  • What’s the definition of “carried out”?
  • How can we format our code? — line spacing, when to interrupt traces, can we add operate parameter names (the place relevant)
  • Can we favor efficiency or readability?
  • What’s our testing philosophy? Can we favor element exams over integration exams?
  • Class/Package deal/Perform naming conventions
  • Logic layers — does it all the time make sense to separate DTOs and fashions?
  • When writing APIs, can we favor throwing Exceptions over Response objects?

The record goes on in fact. The primary aim is to set a transparent normal for writing good high quality code. That means, we will cut back cognitive load and cut back time spent endlessly debating PRs, thereby giving our crew a big efficiency enhance.

Perfection comes at a price. Psychology teaches us that we don’t have to be excellent mother and father to lift wholesome youngsters. That’s additionally true on your code. You don’t have to jot down excellent code to be an efficient developer. Striving to jot down excellent code will most certainly result in frustration and burnout, as a result of perfection is subjective.

The aim of writing code is to resolve issues.

So, get clear on what constitutes “Good Sufficient” code for your enterprise, set clear tips, and expertise a big enhance in productiveness and developer wellbeing.

More Posts