logoalt Hacker News

bsjshshsbyesterday at 11:28 AM1 replyview on HN

Art is knowing what to document. And how to organize it. This is probably not a solved problem and needs constant care and refactoring like the code itself.

Giving people additional documented responsibilities helps. Lucy is responsible for API docs and swagger up to date and for building that out as business needs. Varun is responsible for coding practices docs. And so on. If something is out of date they update it. Use Confluence or Notion or something else good.


Replies

jacquesmyesterday at 12:11 PM

Agreed in principle, but I think the real art is to keep it up to date over the longer term.