Click here to Skip to main content
15,867,568 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.

 
GeneralRe: Importance of Documentation Pin
Mircea Neacsu23-May-22 9:03
Mircea Neacsu23-May-22 9:03 
GeneralRe: Importance of Documentation Pin
Sander Rossel24-May-22 0:47
professionalSander Rossel24-May-22 0:47 
AnswerRe: Importance of Documentation Pin
trønderen22-May-22 6:19
trønderen22-May-22 6:19 
AnswerRe: Importance of Documentation Pin
PhilipOakley22-May-22 22:36
professionalPhilipOakley22-May-22 22:36 
AnswerRe: Importance of Documentation Pin
Cpichols23-May-22 2:20
Cpichols23-May-22 2:20 
GeneralRe: Importance of Documentation Pin
MarkTJohnson23-May-22 2:52
professionalMarkTJohnson23-May-22 2:52 
GeneralRe: Importance of Documentation Pin
Cpichols23-May-22 3:03
Cpichols23-May-22 3:03 
AnswerRe: Importance of Documentation Pin
RussellT23-May-22 3:03
professionalRussellT23-May-22 3:03 
I once took over a codebase that was in the form of hundreds of UNIX shell scripts in which there was not a single line of comments in any of them. This was exactly at the moment that things were rapidly going to hell in production, and the problem was somewhere in this group of scripts. I reached out to the 'programmer' of the scripts who said that the code itself was the documentation and that (he knew that I was a very good shell programmer) I should be able to figure it out. While it is true that I could unwind the code eventually, we were in a crisis situation where I needed to quickly identify the specific line of code that was causing problems. There was no time for crawling through code, and that is the whole point.

If there is a high urgency, there is no time to 'learn the code'. In that case, a simple, one line sentence at the top of each script--'this script does x'--would have helped enormously. SOME documentation is ALWAYS needed.

Cheers,
Russ
AnswerRe: Importance of Documentation Pin
Matt Bond23-May-22 5:28
Matt Bond23-May-22 5:28 
AnswerRe: Importance of Documentation Pin
NightPen23-May-22 5:43
NightPen23-May-22 5:43 
GeneralRe: Importance of Documentation Pin
RussellT23-May-22 11:33
professionalRussellT23-May-22 11:33 
GeneralRe: Importance of Documentation Pin
NightPen23-May-22 15:09
NightPen23-May-22 15:09 
AnswerRe: Importance of Documentation Pin
pmauriks23-May-22 18:24
pmauriks23-May-22 18:24 
GeneralHave a good funky weekend ;) Pin
0x01AA21-May-22 8:24
mve0x01AA21-May-22 8:24 
GeneralRe: Have a good funky weekend ;) Pin
Sander Rossel22-May-22 2:49
professionalSander Rossel22-May-22 2:49 
GeneralThe world's leading expert on European wasps walks into a record shop. Pin
OriginalGriff21-May-22 8:16
mveOriginalGriff21-May-22 8:16 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Mike Hankey21-May-22 8:25
mveMike Hankey21-May-22 8:25 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Marc Clifton21-May-22 8:55
mvaMarc Clifton21-May-22 8:55 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Mike Hankey21-May-22 9:03
mveMike Hankey21-May-22 9:03 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
OriginalGriff21-May-22 10:17
mveOriginalGriff21-May-22 10:17 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
englebart22-May-22 14:23
professionalenglebart22-May-22 14:23 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
OriginalGriff22-May-22 18:54
mveOriginalGriff22-May-22 18:54 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
trønderen21-May-22 10:26
trønderen21-May-22 10:26 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Amarnath S21-May-22 16:33
professionalAmarnath S21-May-22 16:33 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Kelly Herald23-May-22 3:26
Kelly Herald23-May-22 3:26 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.