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

What I personally do when stuff is straightforward is question how and why it is straightforward to me.

Usually, I realize it is because it's following whatever is my framework's way of doing things, or it is following the usual specs of the tools I use. In this case, I make a conscious effort to dig up a link to a tutorial on a "standard project", and link it there, an example would be:

> This project is following a Classic Java Spring Architecture (-> links to the spring tutorial), with this and this modification...

You have to imagine that people happening upon your documentation might have a totally life experience than you, they may even be a lowly intern, thrown to your project as the sole maintainer of your code, with only school-taught experience.



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

Search: