Currently researching the question with very limited industry experience myself and wonder: does everything ok here?
Complete and clear documentation of large legacy codebase is how common exactly in your experience?
Did API-documentation tools in the era of microservices aka Swagger/Postman/etc. eliminated the question completely?
My priors:
- Clear documentation on high-level decisions and architecture is a good guide
- Well docs on particular piece of code / service saves ton of time for other person to work with - to update or debug.
- It's actually more probable in your company/team that code won't be documented on level considered "good"
- The trickiest truth: it's rather boring to create and maintain documentation yourself and rarely rewarded career-wise, even inside one team.
So:
lots of newbees to the industry (see-me) won't have a knowledge of those processes from college; likely won't see them implemented in their team/org; likely won't see any career benefits from implementing the process as it won't seem great at perf review. Cycle ends here.
Complete and clear documentation of large legacy codebase is how common exactly in your experience?
Did API-documentation tools in the era of microservices aka Swagger/Postman/etc. eliminated the question completely?
My priors: - Clear documentation on high-level decisions and architecture is a good guide - Well docs on particular piece of code / service saves ton of time for other person to work with - to update or debug. - It's actually more probable in your company/team that code won't be documented on level considered "good" - The trickiest truth: it's rather boring to create and maintain documentation yourself and rarely rewarded career-wise, even inside one team.
So: lots of newbees to the industry (see-me) won't have a knowledge of those processes from college; likely won't see them implemented in their team/org; likely won't see any career benefits from implementing the process as it won't seem great at perf review. Cycle ends here.
What am I missing in the view here?