Hack: Documentation
Writing and updating documentation pays dividends for you and for your team.
Signals for when to write documentation include:
- Explaining the same thing again and again
- Spending a lot of time figuring something out
- Misleading or confusing documentation - you can update it!
I often write documentation with future me as the primary audience, but in such a way that it benefits others too.
Here are a few examples of documentation work:
- I was reading a document at work about how to authenticate with a service and found several points confusing; once I figured it out, I updated the document. Others said it was an improvement.
- I lead a medical mission trip and kept a running doc of all the things I wish I’d known; I plan to turn this into a guide for future team leaders (including future me).
P.S. If you want to learn more about documentation, you might enjoy the documentation system.
See all hacks.