Documentation is vital for software developers. It boosts understanding, ensures thoroughness, improves collaboration, and saves future time and effort.
Please document your work! I’m speaking from the context of a software developer/architect, but this also applies elsewhere.
Currently, it may feel like a waste of time. You may think, “I’ll remember this.” or “I’ll never do this again.” I’ve been there (and still think this). However, documenting has so many advantages. I’m pushing myself to do better at it constantly. More documentation with less effort.
Creating documentation is a great way to go through whatever it is in greater detail and ensure you don’t miss anything. I can’t count how many
Argues for comments that explain code's purpose to other developers, serving as a guide and documentation extension rather than code repetition. It also stresses deleting commented-out code and relying on source control.
For many years, I thought my code should be clean and easy to read, and therefore I don’t need to use comments. The code itself should be “self-documenting”.
Over time, my view on comments has changed. I’ve learned to appreciate comments in my solutions, especially when I’m not the only developer.
I’m currently reading A Philosophy of Software Design, which has a section of the book dedicated to comments in your code. The author’s viewpoints aligned with my own.
I find it easier to write the comments for a new piece of code before
Last week, I felt the urge to give Linux a try, for some reason. Perhaps the recent influx of “AI” on Windows and Mac has sparked this desire. I’m not against AI, but I’m unsure if I want it integrated into my OS.
I have an old Surface 3 Laptop that I’ve been using while on the go. I decided to install Linux on it. I use my laptop for the browser, Obsidian, and Visual Studio Code, all of which should work great on Linux.
I first tried Ubuntu. After finally getting it set up on a
