Document your old projects and code

For this Valentine’s day, I’m going through old code to show it some love!

More likely than not, after writing something, I (and probably you as well) have been too busy to properly document it.

Even if the code was pushed to GitHub, it probably is not useable because

  • there is no (or very limited) documentation, making it impossible for other people to use unless they go through the code.
  • even going through the code it may not be obvious why the problem was solved in that specific way, leading to a lot of head-scratching. One of the biggest contributions you can make is explaining the “why.”
  • even you don’t (or won’t) remember what it does!
  • it does not contain a license, making it unclear whether someone can even use it in the first place.

Therefore I’ll be going through my repos, code directories, and notes. I’ll be documenting what is not documented, pushing what isn’t pushed, and linking it all through this site to provide discoverability.

Leave a comment