Imagine you are sitting next to a person who will be taking over your code. How ... | Hacker News

Hacker Newsnew | past | comments | ask | show | jobs | submit

		sytelus on Oct 6, 2014 \| parent \| context \| favorite \| on: Ask HN: How do I write good documentation? Imagine you are sitting next to a person who will be taking over your code. How would you explain your code to him/her? Just write down that imaginary conversation and very likely you will have the best documentation of your code.

superice on Oct 6, 2014 [–]

That is a really good point, I'm going to keep that in mind when writing docs!

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact