Beginners and executives sometimes ask why would you even care about code structure. As long as it works, right?
It's true that the code is not the goal, empowering users is the goal. We build the flower and all Super Mario cares about is being able to shoot fireballs.
But code structure does matter. Yes, if you have to choose between perfect code and working software, choose shipping. That's why the big ball of mud is the world's most popular architecture.
It matters because Software engineering is programming over time. It's not about does your code work today, it's about how will you keep it working tomorrow?
You won't know the right structure to use right away. Developing software is like kicking a can. If you force too much structure too soon, you'll slow yourself down and build the wrong structure that's a pain in your neck forever.
You can't fix the wrong abstraction.
But with zero structure, you will hit a wall.
You won't be able to grow your team or give away your legos. A team will step on each other's toes and feel like there's too many chefs in the kitchen. And only folks who have the whole codebase memorized will be able to help.
As the codebase grows, memorizing the whole thing becomes impossible. The codebase always grows.
The toughest transition for every engineer is when they learn to work with a team and accept that theyβll never know the full codebase https://t.co/MyfclmgMyi
β Swizec Teller (@Swizec) September 1, 2024
Your best bet is to make code easy to move around.
- use idempotent functions
- avoid dependencies outside your scope
- declare your types
- define clear interfaces
- strictly separate the inside/outside of your blob
- let the domain guide your design
- prefer duplication over smooshing concerns
Cheers,
~Swizec
Continue reading about Why even care about code structure
Semantically similar articles hand-picked by GPT-4
- The code is not the goal
- Finding modules in a big ball of mud
- Big Ball of Mud βΒ the world's most popular software architecture
- You can't fix the wrong abstraction
- Your code doesn't matter
Learned something new?
Read more Software Engineering Lessons from Production
I write articles with real insight into the career and skills of a modern software engineer. "Raw and honest from the heart!" as one reader described them. Fueled by lessons learned over 20 years of building production code for side-projects, small businesses, and hyper growth startups. Both successful and not.
Subscribe below π
Software Engineering Lessons from Production
Join Swizec's Newsletter and get insightful emails π on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.
"Man, love your simple writing! Yours is the only newsletter I open and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. π"
Have a burning question that you think I can answer? Hit me up on twitter and I'll do my best.
Who am I and who do I help? I'm Swizec Teller and I turn coders into engineers with "Raw and honest from the heart!" writing. No bullshit. Real insights into the career and skills of a modern software engineer.
Want to become a true senior engineer? Take ownership, have autonomy, and be a force multiplier on your team. The Senior Engineer Mindset ebook can help π swizec.com/senior-mindset. These are the shifts in mindset that unlocked my career.
Curious about Serverless and the modern backend? Check out Serverless Handbook, for frontend engineers π ServerlessHandbook.dev
Want to Stop copy pasting D3 examples and create data visualizations of your own? Learn how to build scalable dataviz React components your whole team can understand with React for Data Visualization
Want to get my best emails on JavaScript, React, Serverless, Fullstack Web, or Indie Hacking? Check out swizec.com/collections
Did someone amazing share this letter with you? Wonderful! You can sign up for my weekly letters for software engineers on their path to greatness, here: swizec.com/blog
Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com
By the way, just in case no one has told you it yet today: I love and appreciate you for who you are β€οΈ