Some weeks ago I posted a tweet about the importance of technical documentation. I stated that as a Software Engineer, technical documentation is as important as making technical decision.
As a Software Engineer, documenting your technical decisions is as important as making them.
— Jide Owosakin (@jidesakin_) January 30, 2019
Techical documentation helps you clarify your thoughts and validate your assumptions. It also provides clarity to other engineers on your team.#TechnicalDocumentation
I want to share a couple of guides that I consider good practices to technical documentation. Some of the things I would share are practices you are probably familiar with.
- Write READMEs - this is the basic minimum. Every repositories should have at least readme file.
- Use confluence (or it's equivalent) for documenting your technical decision process.
- Write Wikis. Use wikis for more detailed documentation of your code base, architecture and other technical details.
