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

Writer friendly comments/documents....

I am guilty of them also. A lot of time after 6 months, 1 year and I go back to the source/document I wrote, I have hard time out my writings.

I think the reasons are a lot of sentences/paragraph we wrote are highly dependent on the contexts of author's mind and the state of that particular moments of developments. It might just make sense within those contexts. When one forgot them or other try to read sentences out of the context, it become very difficult to understand.

I have some documents on power management code related to particular SOC + linux kernel + .ko + user app + pm scripts. They are very hard to understand for myself after a few months.

I don't know the best way to solve this.



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

Search: