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.

Edidiong Asikpo's photo

Your process of documenting what you learn is quite similar to mine Francisco Quintero. Usually, I write about what I have learned on either a book or on a Google doc created for the particular technology or programming language. I love to use my own words when documenting because whenever I come back to look at it, I quickly remember the function of that particular method or technology.

On a Google Doc, I add images, code snippets, and a brief explanation about the code snippet and links to resources that provide more explanation on the subject.

In my book, I draw out a diagram that explains the function of the technology or method, add brief examples of how it works, and when it can be used. For example, when I learn about padding and margin in CSS, I drew a box and indicated effects of either adding margin or padding to a box.

I think it is very important to document what you learn because you would most likely need that information someday.

Francisco Quintero's photo

Software Engineer & Ruby on Rails Developer

Awesome, Edidiong :)

This summarizes why I do it and have never stopped:

I think it is very important to document what you learn because you would most likely need that information someday.

I never thought of Google Docs for this purpose because I think it's code snippets aren't good enough but it's good to know it works as well.

Thanks for sharing how you do it :)

Sharon Leah's photo

Software Developer

Am so glad this information has really helped me a lot. I rarely document but now I will begin to. Thank you!

Want to read more?

Browse featured discussions

© 2020 · Hashnode