Programmer Humor

‘code documentation’

You don't get it, and that makes me sad.

Case in stunning point: my peer retired yesterday. His last 10 years with the company was in the group with me. One of his tasks this week was to back up his daily work journal so we can refer to it.

His documentation isn't mandated but strongly encouraged, and since we're Union the boss was able to carve out time after each job for "documentation as required.". And, as we're Union, that became a check-box on the task that we all use as we do the risky shit ("snapshot taken", "starting on correct time"; just simple shit after fuckups, like how doctors now write on your body "operate on this limb"). And I had to pull it up for reference today, the day after he left and is legally not allowed to help.

His documentation is fucking gorgeous.

Honestly, it's the best thing he could have left us. "How did Benjamin do this" is almost our WWJD, because he's that good.

Please, don't bitch about having to doc your shit. Doc your shit. You'll value it one day, or your peers will. Write it like it's the fucking best gift in the world, and one day it will be. Benjamin mayyyybe saved a life today, as (vaguely) the thing that needed to do the thing to get a guy a thing got a guy a thing and then he didn't get sick as fuck and maybe die. Outside chance, but I'll take the win.

(And I took his fix and put it into the process doc as it wasn't there, and also opened a ticket to fix the thing that needs this thing, etc, and checked off my 'docco' box ;-) )