Earlier quoted context omitted.
Whoever thinks comments are a code smell has probably stumbled into a nest of documented code where the documentation was out of date and didn't refer to the latest code in question, causing intense confusion. Comments can certainly be helpful but there is nothing to guarantee that they will be up to date or even useful.
Indeed. Had to port a 2k perl script with gigantic comment blocks written in German. Eventually I recreated the intended functionality with ~150 lines of JS after painfully google translating everything. JIRA references would probably be lost completely by the time I worked on it.
Stack Overflow for Teams
131–140 of 163 posts
Re: Stack Overflow for Teams
#132Re: Stack Overflow for Teams
#133Seems like "yet another tool to try to offset the problem of requirements, code, and architectural decisions not being adequately documented for future staff to understand." 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…
Version control?
Re: Stack Overflow for Teams
#134Seems like "yet another tool to try to offset the problem of requirements, code, and architectural decisions not being adequately documented for future staff to understand." 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…
>provide an historical record that answers "How the hell did our systems end up looking like this?" Version control?
Re: Stack Overflow for Teams
#135Re: Stack Overflow for Teams
#136I want to create a public Stack Overflow, just using the engine but rebranded as my own QA site.
Re: Stack Overflow for Teams
#137Seems like "yet another tool to try to offset the problem of requirements, code, and architectural decisions not being adequately documented for future staff to understand." 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…
> Sometimes I wonder if software teams should add technical writers... I have been wondering the same thing fairly frequently of late. I see a few different potential benefits to something like this: 1) I communicate with relatively low friction face-to-face, but writing is like pulling teeth. Being able to outsource the formalization of knowledge would allow me to spend my time doing what I'm good at. I would hazard…
Re: Stack Overflow for Teams
#138Earlier quoted context omitted.
>provide an historical record that answers "How the hell did our systems end up looking like this?" Version control?
Version control only answers "what happened?" not " why did this happen?"
Re: Stack Overflow for Teams
#139Earlier quoted context omitted.
> If I post an answer, only I can modify it. Teams users won't be able to edit answers?
Well, I'm assuming it works like Stack Overflow. I can edit my own posts, but not those of others. Only high reputation moderators have the ability to edit other people's posts. Here's how we coach moderators on the internal Stack-like site we run... Editing When editing content written by others, do so with respect to the person who is the original author of the content. Correct simple spelling and grammatical error…
Re: Stack Overflow for Teams
#140Earlier quoted context omitted.
Whoever thinks comments are a code smell has probably stumbled into a nest of documented code where the documentation was out of date and didn't refer to the latest code in question, causing intense confusion. Comments can certainly be helpful but there is nothing to guarantee that they will be up to date or even useful.
Indeed. Had to port a 2k perl script with gigantic comment blocks written in German. Eventually I recreated the intended functionality with ~150 lines of JS after painfully google translating everything. JIRA references would probably be lost completely by the time I worked on it.