Timeline for How to make a large codebase easier to understand
Current License: CC BY-SA 3.0
6 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Aug 1, 2015 at 15:03 | comment | added | Lightness Races in Orbit | If you have a team of programmers working on a product, and each programmer only understands the specific code that they worked on, then not only is your team incredibly dysfunctional with an absurd bus factor, but one questions the quality of the code. How does one integrate code into a product without understanding the rest of the code in the same system??!? | |
| Aug 1, 2015 at 10:57 | comment | added | user52889 | This doesn't seem to answer the question, which was looking for reasons why the documentation style proposed would or wouldn't work, and also for documentation standards. | |
| Aug 1, 2015 at 10:47 | history | edited | Michael Durrant | CC BY-SA 3.0 |
added 14 characters in body
|
| Aug 1, 2015 at 9:41 | comment | added | slebetman | If you look at github you'll find a lot of projects that have this kind of note in a README.md file. It's become so much a part of the culture of git in general and javascript projects in particular to most people won't use a library that does not have this sort of high level documentation. So it's untrue that "no programmer would write it" since you only need to look at something like jQuery or socket.io and find programmers who write such things. It has also become a culture that README files that are not accurate generate bug reports. | |
| Aug 1, 2015 at 5:19 | review | First posts | |||
| Aug 1, 2015 at 10:57 | |||||
| Aug 1, 2015 at 5:17 | history | answered | Ilqar Rasulov | CC BY-SA 3.0 |