So glad I wrote docs....

Last Update: 02.11.2018. By Jens in Newsletter

I developed a small utility for sending bulk emails a year or so ago. Reads a CSV file, parses a text template and send the emails. Simple, tiny. Yeah, right.

Only, that I haven’t used it in a long time. So, I didn’t remember the field order in the CSV, nor its delimiter or the placeholder format in the template. Good, that I wrote docs for it. Up and running in a minute instead of digging through the code now.

Now 1000x that and you get an average application we usually work on. And your pain quadruples on top of that because there are no docs, or plainly outdated, wrong, you name it. so, remember you write those for your future self. If that doesn’t help, remember how often you wanted to punch your past self for not documenting that piece of shit you just plow through?!?!

I do, I do.

Have a nice weekend :-)