- readme at the root of each of application with keeping it up to date part of each relevant change. Something perhaps to consider in peer reviews.
- onboarding checklist with the new person now responsible for the checklist so when the next person needs it they can take them through it.
- mentoring with real contact between the new person and the mentor so they engage in shadowing and pairing.
- wikis are generally pretty poor, partly as they are external to the daily work, partly because nobody is made responsible. Could you delete it?
Of these I consider the README to be the most important. Imagine you are an open source application and you want to encourage others to improve your code. How would you do that? Add clear instructions on how to get it working on every platform? Include diagrams, made with simple, free tooling like Mermaid and drawio? Describe architectural decisions?
- onboarding checklist with the new person now responsible for the checklist so when the next person needs it they can take them through it.
- mentoring with real contact between the new person and the mentor so they engage in shadowing and pairing.
- wikis are generally pretty poor, partly as they are external to the daily work, partly because nobody is made responsible. Could you delete it?
Of these I consider the README to be the most important. Imagine you are an open source application and you want to encourage others to improve your code. How would you do that? Add clear instructions on how to get it working on every platform? Include diagrams, made with simple, free tooling like Mermaid and drawio? Describe architectural decisions?