What is your process to document what you learn while writing code?

View other answers to this thread

Learn Something New Everyday,
Connect With The Best Developers!

Sign Up Now!

& 500k+ others use Hashnode actively.

Tapas Adhikary's photo

Francisco Quintero Your way of doing sounds great to me πŸ‘.

Btw, I think this is not easy to do and maintain(at least with me). Over the time, I have learned what not to document so that, I do not feel paranoid of not following it often.

Finally, I have settled down to followings:

  • Anything that is shareable publicly, must have an entry here. Wherever applicable, should have related examples in github.
  • Something that is not shareable publicly(may be very much organization specific or proprietary), I would have private EverNote pages created to maintain those for future references. In these cases too, I try to create code examples and push to Organization's GHE.
  • I also bookmark my contributions to StakeOverFlow so that, I do not have to search for what quick hack I found before πŸ˜†.

It is externally important to have documentation some ways. I feel, it is equally important to share those publicly wherever possible.

Thanks for asking this question and great to read other responses too! Cheers!

Francisco Quintero's photo

Software Engineer & Ruby on Rails Developer

Thanks for sharing how you do it, Tapas.

I have learned what not to document so that, I do not feel paranoid of not following it often.

This is also very important. Trying to document absolutely everything is a way to madness xD

Want to read more?

Browse featured discussions

Β© 2020 Β·Β Hashnode