Post

Not the first thing that most of us reach for, but I actually really enjoy writing documentation. I think it’s just as important, if not more so than the code itself. It’s surprising how much you can take away when you have to step outside of your head to explain things for other devs to grok.

There have been so many instances where, as I’m writing and running through things I find ways to improve or simplify the APIs themselves. If I’m finding it difficult to show or describe how to get started or use something, then I think about how much more difficult it will be for others.

It doesn’t have to be “fancy” either. Just start with a README and go from there. Over time as you write more you’ll begin to find a style and approach to how you’d like to organize things at a larger scale 💪

And don’t be afraid to imitate others! There are tons of great resources out there to glean ideas in writing style and organization. I’m sure you use some of these on a regular basis too. CodeIgniter was my first exposure to what great documentation could be.