The Unsung Rules of Software Development
Follow these to minimise annoyance amongst your colleagues
Software engineering covers a huge range of work. Saying someone “writes” doesn’t tell you whether they’re a poet, a novelist, a journalist or a lawyer. Similarly, saying someone “writes software” can mean many things. For instance, a kernel engineer, a graphics engineer and a web developer are all software engineers, but their day-to-day work has little in common. The kernel engineer needs to understand concurrency, memory management and hardware, and the graphics engineer may need a solid grounding in mathematics. The web developer needs neither, but has to know about API design, the DOM and managing client-side state.
Despite the difference in what they produce, all writers (or at least all good writers) still need to draft, revise, keep track of versions and follow some kind of style guide. This is because writing, by its very nature of being a creative pursuit invites chaos (albeit more or less creative, depending on the context). To create is to arrange some amount of chaos, which you then distil something productive from. Drafting, revising and the rest are how writers keep that chaos under control. The same goes for software engineers and the projects they work on.
I don’t think it’s a stretch to claim that most people enjoy cooking more than they enjoy doing the dishes afterwards. I’d also wager that a writer would rather be writing than proofreading. The same can be said for most software engineers. We enjoy solving a problem with software that is efficient, elegant or clever, and we spend a lot less time thinking about the housekeeping that comes with it. The trouble is that software doesn’t stay finished. At some point it’ll need changing, extending or fixing, and someone has to go back in and figure out what’s going on. I’ve been that someone more than once, staring at code I wrote myself with no idea why I wrote it that way.
More often than not, that someone is someone else. There are rules we can follow to make this person’s life easier, or at the very least, not harder. It is in your best interest to follow these rules, so as to avoid cultivating annoyance in your colleagues. The problem is that these rules are seldom taught, and most developers learn them by osmosis. This series covers the rules I’ve picked up so far, in the order I wish someone had explained them to me.
Articles#
- The Unsung Rules, Part 0: What is git? (coming soon)
- The Unsung Rules, Part 1: Commits and History (coming soon)
- The Unsung Rules, Part 2: Branching and Collaboration (coming soon)
- The Unsung Rules, Part 3: Versioning and Releases (coming soon)
- The Unsung Rules, Part 4: Repo layout and Documentation (coming soon)
- The Unsung Rules, Part 5: Tooling and Guardrails (coming soon)
- The Unsung Rules, Part 6: CI/CD (coming soon)