Click here to Skip to main content
15,504,424 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.

 
AnswerRe: Importance of Documentation Pin
Mircea Neacsu21-May-22 16:41
mvaMircea Neacsu21-May-22 16:41 
GeneralRe: Importance of Documentation Pin
Richard Andrew x6421-May-22 17:09
professionalRichard Andrew x6421-May-22 17:09 
GeneralRe: Importance of Documentation Pin
Mircea Neacsu21-May-22 17:37
mvaMircea Neacsu21-May-22 17:37 
AnswerRe: Importance of Documentation Pin
Jacquers21-May-22 20:27
Jacquers21-May-22 20:27 
AnswerRe: Importance of Documentation Pin
RickZeeland21-May-22 23:32
mveRickZeeland21-May-22 23:32 
AnswerRe: Importance of Documentation Pin
Daniel Pfeffer22-May-22 1:04
professionalDaniel Pfeffer22-May-22 1:04 
AnswerRe: Importance of Documentation Pin
Sander Rossel22-May-22 3:22
professionalSander Rossel22-May-22 3:22 
GeneralRe: Importance of Documentation Pin
Mircea Neacsu23-May-22 10:03
mvaMircea Neacsu23-May-22 10:03 
Can I respectfully disagree?

First let's clarify what I call "documentation". There is no generic "documentation" but documentation for a certain purpose. To make an analogy with the auto industry, you have the user manual that you get with any new car, than you have a service manual that mechanics use and you have design documentation that stays in the factory. They are not interchangeable and none of them replaces the other ones. You don't want to look at the service manual when you buy a new car and the mechanic has no use for the users' manual (you'd hope he's seen that type of car before). And of course you don't get to see the design documentation that manufacturers guard jealously.

Pretty much the same applies to software. I think the OP was talking about design documentation, or the lack of thereof. It should explain the whys and tell little about the hows. Presumably the purpose of the system and the design don't change that often as to make it constantly obsolete.

What you seem to refer to, is what I call "user manual": how to get the code, where are the passwords and so on. These are the nitty-gritty details that are very helpful but don't explain why the system was designed in a certain way nor how it was implemented.

Finally, for the "service manual", the one that explains how the design comes to life, comments are just perfect. They are right there on the shop floor when the mechanic needs to fix something and can be updated right away when something changes.
Mircea

GeneralRe: Importance of Documentation Pin
Sander Rossel24-May-22 1:47
professionalSander Rossel24-May-22 1:47 
AnswerRe: Importance of Documentation Pin
trønderen22-May-22 7:19
trønderen22-May-22 7:19 
AnswerRe: Importance of Documentation Pin
PhilipOakley22-May-22 23:36
professionalPhilipOakley22-May-22 23:36 
AnswerRe: Importance of Documentation Pin
Cpichols23-May-22 3:20
Cpichols23-May-22 3:20 
GeneralRe: Importance of Documentation Pin
MarkTJohnson23-May-22 3:52
professionalMarkTJohnson23-May-22 3:52 
GeneralRe: Importance of Documentation Pin
Cpichols23-May-22 4:03
Cpichols23-May-22 4:03 
AnswerRe: Importance of Documentation Pin
RussellT23-May-22 4:03
professionalRussellT23-May-22 4:03 
AnswerRe: Importance of Documentation Pin
Matt Bond23-May-22 6:28
Matt Bond23-May-22 6:28 
AnswerRe: Importance of Documentation Pin
NightPen23-May-22 6:43
NightPen23-May-22 6:43 
GeneralRe: Importance of Documentation Pin
RussellT23-May-22 12:33
professionalRussellT23-May-22 12:33 
GeneralRe: Importance of Documentation Pin
NightPen23-May-22 16:09
NightPen23-May-22 16:09 
AnswerRe: Importance of Documentation Pin
pmauriks23-May-22 19:24
pmauriks23-May-22 19:24 
GeneralHave a good funky weekend ;) Pin
0x01AA21-May-22 9:24
professional0x01AA21-May-22 9:24 
GeneralRe: Have a good funky weekend ;) Pin
Sander Rossel22-May-22 3:49
professionalSander Rossel22-May-22 3:49 
GeneralThe world's leading expert on European wasps walks into a record shop. Pin
OriginalGriff21-May-22 9:16
mveOriginalGriff21-May-22 9:16 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Mike Hankey21-May-22 9:25
professionalMike Hankey21-May-22 9:25 
GeneralRe: The world's leading expert on European wasps walks into a record shop. Pin
Marc Clifton21-May-22 9:55
mvaMarc Clifton21-May-22 9:55 

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.


Straw Poll

How would you describe your current job?
Fighting dragons everyday or clicking the same boxes on the same forms, day after day?
  Results   407 votes