Hacker News new | ask | show | jobs
by Jaxkr 2303 days ago
What kind of information is this best suited for? What is best to use nots for, and what belongs in a comment?
1 comments

Any information around the code: short text or link on what code does. The bigger technical specification in markdown. PDFs/images/GDocs that describe why code looks the way it looks.

You're using some non-standard language feature -- document! Choosing a library over its competitor -- leave a note! Re-writing or re-implementing a module, making some tradeoffs in code, dropping an existing feature -- all this should be saved in docs. For the future-you, for your colleagues, for the newcomers, for teammates who work remotely.

We make this internal "tribal knowledge" to be accessible for anybody in the team in a couple of clicks.