I'm working on a project where I've added a new feature to a multi-tool application. I went all out to follow software engineering best practices since I wanted to enhance my design skills. This includes selecting an architecture pattern like MVM, applying DRY principles, and utilizing various config.py files. While the feature is performing well and feels quicker than some existing tools, it's a pretty straightforward task: taking user input via a GUI and generating a PDF report. I'm curious about how to assess whether my approach is overkill and if I'm straying from my goal of implementing best practices without complicating things unnecessarily.
3 Answers
If you think the feature might need to change in the future, then your work is justified. Following standards is good if you can configure it later. But if this is a one-off task and your feature is always going to stay the same, then maybe those extra layers of complexity don’t make sense. It's hard to say without more context, though.
There are usually three competing goals for programmers: getting the project done quickly and correctly, making code beautiful and maintainable, and learning new things. Leaning too hard into any one of these can lead to problems. A good rule of thumb is, if the effort you put in doesn't earn you tangible benefits, you've probably wasted time. If you sacrifice maintainability to finish early but end up spending ages on maintenance, that’s a mistake. Consider if the extensive effort helped you achieve what mattered most.
When assessing whether you’ve over-engineered, ask yourself: what makes these practices 'best'? Try listing out what you’ve implemented, and evaluate the necessity of each item. This can help clarify if you went overboard.
Related Questions
How To: Running Codex CLI on Windows with Azure OpenAI
Set Wordpress Featured Image Using Javascript
How To Fix PHP Random Being The Same
Why no WebP Support with Wordpress
Replace Wordpress Cron With Linux Cron
Customize Yoast Canonical URL Programmatically