2 ms·
While reading 'teh codez' can work for a (simple) app it will get you nowhere regarding the whole service architecture/infrastructure. There can and will be se
by jskrablin 7y ago
While reading 'teh codez' can work for a (simple) app it will get you nowhere regarding the whole service architecture/infrastructure.
There can and will be several services/apps working together, external services required for some stuff, different set of configurations for different environments, CI/CD, software packaging, etc...
How we deal with it where I work - service developers/owners are responsible for providing docs for their services. Ops provide infra/CI/deployment/high level 'how all this works together' docs. Everything that can be code, should be code - with it's documentation. Of course there's issue tracker, wiki, commit messages all tied together using issue tracker IDs, etc.
And it still takes time for new people to get their heads around the 'how everything is working together'. Amount of docs we're writing is significant. Some of the docs is auto generated. Time for docs keeping is accounted for at estimating the time required for developing new features. Being a member of a remote team I can't imagine how we could be able to work otherwise.