I'd like to explain the question a little bit. In our team, we are trying to create something we call "codebase knowledge". It's anything related to our code and technological solution that is important to know through the team. For example specific algorithms we're using and why, platform-specific decisions and caveats, or just simple explanation of how some internal API works.
I wonder, do you keep the same knowledge in your team? If so, where do you keep it and what software do you use?
Our problem is that currently, this knowledge is spread across Google Docs, Slack, readmes, code comments, or sometimes it's just vocal...
We write and update these documents when needed (this usually means when something has changed in the code) and when knowledge is fresh in people's mind.
If documents are referenced in the code it is straightforward to find them when needed. We also have documents to capture general architecture, which obviously help devs finding their way around the codebase.
4 comments
[ 2.9 ms ] story [ 18.6 ms ] threadI'd like to explain the question a little bit. In our team, we are trying to create something we call "codebase knowledge". It's anything related to our code and technological solution that is important to know through the team. For example specific algorithms we're using and why, platform-specific decisions and caveats, or just simple explanation of how some internal API works.
I wonder, do you keep the same knowledge in your team? If so, where do you keep it and what software do you use?
Our problem is that currently, this knowledge is spread across Google Docs, Slack, readmes, code comments, or sometimes it's just vocal...
How do you solve this issue?
If you do it the way you described, isn't it hard to search for some specific knowledge?
If documents are referenced in the code it is straightforward to find them when needed. We also have documents to capture general architecture, which obviously help devs finding their way around the codebase.