A Guide on Technical Documentation

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.

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.

  1. Write READMEs - this is the basic minimum. Every repositories should have at least readme file.
  2. Use confluence (or it's equivalent) for documenting your technical decision process.
  3. Write Wikis. Use wikis for more detailed documentation of your code base, architecture and other technical details.
Show Comments