I've started doing this in my larger projects e.g. https://github.com/kstenerud/go-concise-encoding/blob/master/ARCHITECTURE.md https://github.com/kstenerud/go-

I've started doing this in my larger projects e.g. https://github.com/kstenerud/go-concise-encoding/blob/master/ARCHITECTURE.md https://github.com/kstenerud/go-concise-encoding/blob/master... An architecture document should be the code equivalent of a combined street map and tourist guide. Its purpose is to bring strangers up to a minimum level of familiarity with the code as quickly as possible. That includes where things are, why it was architected this way, things to look out for, and a few interesting points of weirdness perhaps.