Stack Overflow for Teams
Seems like &quot;yet another tool to try to offset the problem of requirements, code, and architectural decisions not being adequately documented for future staff to understand.&quot; Sometimes I wonder if software teams should add technical writers embed with developers, architects, QA, and BA assets to actually document All The Things and keep documentation up to date. Yes, that will mean re-writing documentations as people change their minds in response to business needs but it would provide an historical record that answers &quot;How the hell did our systems end up looking like this?&quot; which seems to plague every organization that hires programmers to write custom code. Sometimes it&#x27;s hard to give the developers who wrote the code the benefit of the doubt that they made the wisest decision based on all known variables at the time. I&#x27;m certainly guilty of questioning the intelligence, breeding, motivations, etc of the programmer of an app I had to modify once... only to realize that <i>I</i> had written the code in question four years previously. Eventually I remembered why the feature had to be coded that way and wrote a 1200 word comment section explaining why the feature was written the way it was and how one should orient their state of mind to understand and edit the logic. And I further apologized for the clusterfuck of code that the feature was and left my personal email address in case a future programmer wanted to berate me for it. And three years later I did get an email from someone saying they had been laughing for ten minutes because they had gone from &quot;WTF?&quot; to gradual understanding as they read through my verbose description of why... ending with laughter that I was willing to take whatever vitriol they had left over via email so they could vent and get back to work. Whether that dev updated the comments to reflect their changes is something to which I have no answer.