Timeline for How do you validate need for documentation?
Current License: CC BY-SA 3.0
11 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Jun 25, 2014 at 16:03 | comment | added | ebyrob | I think there's a maximum and minimum here... A useful maximum, for in-code comments would be "every file header" "every method header" has useful, complete, specific comment descriptions. At a minimum? Some say proper naming does 90% of documentation's work. Of course, devs should be able to instantly work in others code they've never seen when this is true. Perhaps a minimum would be have devs fix each others code and pay attention when you hear "I can't read Skippy's modules very well." Often dealing with Skippy will involve convincing him to use simple/standard constructs not comments | |
| Sep 11, 2013 at 11:05 | vote | accept | blunders | ||
| Sep 7, 2013 at 0:21 | answer | added | Abstract Class | timeline score: 1 | |
| Sep 6, 2013 at 18:35 | comment | added | Aaronaught | The "right" way to handle the "hit by a bus" risk is with code review. Documentation ain't worth diddly if you can't understand it, and you won't know if anyone can understand it until they review it, and if you've got someone who can review the documentation, they might as well spend their time reviewing the code. And if your management is worried that the entire team might get "hit by a bus", well then documentation is probably the least of their worries. | |
| Sep 6, 2013 at 18:33 | answer | added | Steven Evers | timeline score: 3 | |
| Sep 6, 2013 at 18:24 | history | edited | blunders | CC BY-SA 3.0 |
added 4 characters in body
|
| Sep 6, 2013 at 18:18 | history | edited | blunders | CC BY-SA 3.0 |
deleted 24 characters in body
|
| Sep 6, 2013 at 18:01 | history | edited | blunders | CC BY-SA 3.0 |
typo found; converted question title in question form
|
| Sep 6, 2013 at 13:23 | comment | added | blunders | @Doc Brown: No, to me an automated solution would not be light enough - though that's just my opinion. | |
| Sep 6, 2013 at 13:16 | comment | added | Doc Brown | Are you looking for a automatic solution, some software tool which solves your problem? Or some kind advice how to change your teams's behaviour? | |
| Sep 6, 2013 at 12:56 | history | asked | blunders | CC BY-SA 3.0 |