Hey all, I’m still a junior dev with years of experience in IT. One of the things I’ve noticed since making the switch is that (at least where I work) documentation is inconsistent.
Things I encounter include incomplete documentation, outdated documentation and written process details that have assumed knowledge which makes it difficult for junior Devs to pick up.
I’ve had a search and a lot of what is out there talks more about product and how to document that SDLC rather than best practice in writing and organising documents against the actual software engineering and its processes.
Does anyone have any good sources or suggestions on how I could look to try and begin to improve documentation within my team?
The Code is my Bible.
Yeah seems about right… off the top of my head:
the output of tools like sphinx, javadoc and so forth is a good starting point, especially if you feed them properly commented code.
the rule “garbage in, garbage out” definitely applirs here.
Writings self documenting code is so important.
Comments get stale and over time transition from: accurate to outdated, to eventually flat-out lies.
Go hard in the paint when choosing method or variable names. If it’s hard to give them coherent names, that’s a code smell.
Sounds like some people aren’t doing their work enough then. Code comments are part of the work that a programmer should do, not an afterthought. Who else is gonna update that code if not the programmer? And if a programmer isn’t supposed to update their code and we can just all write clean code that would somehow make us all be better engineers (yeah, I use this title differently from programmers), then why are code comments even a thing?
Self-documenting code is good and all, but so should there be good comments.
I agree that would be ideal.
I flat out do not trust each of the 500 devs operating on our codebase to maintain comments.
Tests are documentation, code can be documentation. Those run through CI.
If you can keep comments updated at scale, do it. If you can’t don’t pray for a miracle and find something that you actually can enforce
That’s why reviewers should also watch out for comments to ensure their quality. Hence why I said it’s part of a programmer’s job, not some afterthought.
If it’s closed source then it’s a losing battle to try and document code. I mean, do it when you feel it’s 100% necessary (e.g. complex code that you really can’t dumb down, “magic numbers” with a complicated backstory, test cases – it feels like that’s a different part of your brain so the transition is hard). Otherwise write code that almost reads like a sentence and don’t add complexity until you need it.
You mean COBOL?
Hehe. COBOL doesn’t look too bad. Reads a bit like a person that’s never talked to another human being before.