Hacker News new | past | comments | ask | show | jobs | submit login

I agree. Everyone's notion of documentation, its placement and role, can be different.

Some workplace relies on self-documenting code, some would require technical specs to be written in an internal wiki, some uses function/class/module headers.

It is inevitable that someone would ask how should I read the documentation, and any question on slack should be treated as a chance for improvement and better UX for devs.

Repeated questions from different people is a sign of the lack of improvement in the same area.

My usual go-to method to partially solve this issue is to challenge newcomers to write the question they asked and the answer for it, including how to write it, or make change to an existing one, so that other newcomers will find it easier to onboard.




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

Search: