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

Keep your docs in the same repository as your code and enforce relevant documentation updates as part of the code review progress. Works great.


I've held that view before, but in practice adding friction to review and deployment doesn't accomplish much other than frustrating engineers.

Aside from that, the code review process is also too late. A better spot would be during the design process, then updated alongside the implementation to match. By the time you get to code review, the docs for the relevant code should naturally already be written, without needing to set and enforce a docs requirement.




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

Search: