Post from July 20, 2017 (↻ August 22, 2018), filed under Web Development.
Still evaluating and normalizing feedback for the great maintainability survey I’ve so far worked through a ton of excellent comments. All of it will, in a comprehensive fashion, make for a new, updated web maintainability guide, and yet one particular aspect resonated so well with me that I wish to call it out again specifically: the boyscout approach to code.
This approach resurfaced after one of our peers commented the following on “What techniques do you find useful to keep websites maintainable?”: “Refactoring every time you touch something and see potential for improvement.”
We’ve probably all been there at some point, when we saw something and fixed it (a googley principle), and so I instantly nodded, “yes, that’s a great habit.” It reminded of the boyscout credo, attributed to Robert Baden-Powell, to
Leave this world a little better than you found it.
or, more specifically,
Always leave the campground cleaner than you found it.
Always check a module in cleaner than when you checked it out.
…which we could, and I’ve included this in my errata for The Little Book of Website Quality Control, rephrase to simply say:
Always leave code better than you found it.
This is not new, either, but it’s how I’d prefer to spell out the boyscout rule. Always leave code better than you found it.
As I said, there’s progress with the new, survey-inspired maintainability guide; stay tuned on Twitter or through one of this site’s feeds (subscribe just to my developer feed if the rest is not of interest to you).
About the Author
Jens Oliver Meiert is a technical lead and author (sum.cumo, W3C, O’Reilly). He loves trying things, including in the realms of philosophy, art, and adventure. Here on meiert.com he shares and generalizes and exaggerates some of his thoughts and experiences.
If you have any thoughts or questions (or recommendations) about what he writes, leave a comment or a message.
Have a look at the most popular posts, possibly including:
- Stop Using Resets: Visual Examples of the Practical Nonsense of Resets and Normalizers
- What I Learned Building Google’s Web Frameworks
Perhaps my most relevant book: CSS Optimization Basics (2018). Writing CSS is a craft. As craftspeople we strive to write high quality CSS. In CSS Optimization Basics I lay out the, at least some of the most important aspects of such CSS.
Looking for a way to comment? Comments have been disabled, unfortunately.