Click here to Skip to main content
15,918,808 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: Silly Documentation Question Pin
Mike Hankey17-Apr-24 9:18
mveMike Hankey17-Apr-24 9:18 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:05
charlieg18-Apr-24 17:05 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:26
charlieg18-Apr-24 17:26 
GeneralRe: Silly Documentation Question Pin
rob tillaart16-Apr-24 20:50
rob tillaart16-Apr-24 20:50 
GeneralRe: Silly Documentation Question Pin
glennPattonWork316-Apr-24 21:54
professionalglennPattonWork316-Apr-24 21:54 
GeneralRe: Silly Documentation Question Pin
Nelson Goncalves Oct202217-Apr-24 2:17
Nelson Goncalves Oct202217-Apr-24 2:17 
GeneralRe: Silly Documentation Question Pin
jochance18-Apr-24 5:58
jochance18-Apr-24 5:58 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:17
charlieg18-Apr-24 17:17 
And "It can't be too odd" you'd be wrong. I have seen so many developers blow past this area it makes my eyes water. Marc has a good list, but personally I would condense it. The real question is, what are your doc requirements? I had to write MILSPEC docs a long time ago. DD something or other, very specific and completely useless. I went to the USAF Captain handling the project and told him I could give him what he asked for but it would be complete crap and useless. Alternatively, I could give him something useful and we just wrap it in the boilerplate of the doc spec. He was happy.

- if you are documenting code stuff, it must be automated. Else, the doc will become a project of it's own, no one will maintain that part and worse, it will become obsolete and not reflect the code. Frankly, this is mostly useless documentation.

- what you need to build the project - good stuff. Software to install, build procedures, etc.

- my biggest career beef - I rarely come across doc that explains why the code is the way the code is, the abrasions, broken limbs and late nights of things that have bit you, and on and on.

- DO NOT INCLUDE WEB REFERENCES TO INFORMATION. Especially Microsoft. Print the info in PDF form and archive it with the doc. Microsoft routinely prunes useful info for the misguided reason that nobody could possibly care about this any more.
Charlie Gilley

“They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759

Has never been more appropriate.

GeneralWhat sort of performance should I expect? Pin
dandy7216-Apr-24 5:03
dandy7216-Apr-24 5:03 
GeneralRe: What sort of performance should I expect? Pin
PIEBALDconsult16-Apr-24 5:35
mvePIEBALDconsult16-Apr-24 5:35 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 5:46
dandy7216-Apr-24 5:46 
GeneralRe: What sort of performance should I expect? Pin
jochance17-Apr-24 8:01
jochance17-Apr-24 8:01 
GeneralRe: What sort of performance should I expect? Pin
k505416-Apr-24 6:04
mvek505416-Apr-24 6:04 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:00
dandy7216-Apr-24 7:00 
GeneralRe: What sort of performance should I expect? Pin
k505416-Apr-24 7:10
mvek505416-Apr-24 7:10 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:37
dandy7216-Apr-24 7:37 
GeneralRe: What sort of performance should I expect? Pin
theoldfool16-Apr-24 6:54
professionaltheoldfool16-Apr-24 6:54 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:09
dandy7216-Apr-24 7:09 
GeneralRe: What sort of performance should I expect? Pin
theoldfool16-Apr-24 7:32
professionaltheoldfool16-Apr-24 7:32 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:48
dandy7216-Apr-24 7:48 
AnswerRe: What sort of performance should I expect? Pin
Clumpco16-Apr-24 21:14
Clumpco16-Apr-24 21:14 
GeneralRe: What sort of performance should I expect? Pin
Daniel Pfeffer16-Apr-24 21:56
professionalDaniel Pfeffer16-Apr-24 21:56 
GeneralRe: What sort of performance should I expect? Pin
Daniel Pfeffer16-Apr-24 21:54
professionalDaniel Pfeffer16-Apr-24 21:54 
GeneralRe: What sort of performance should I expect? Pin
dandy7217-Apr-24 7:13
dandy7217-Apr-24 7:13 
GeneralRe: What sort of performance should I expect? Pin
Daniel Pfeffer17-Apr-24 23:27
professionalDaniel Pfeffer17-Apr-24 23:27 

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.