The article aptly describes what it's like to start working with essentially any large code project, be it open source or proprietary. Unfortunately you are never going to see a project with comprehensive documentation, I'm not sure what that would even look like.
Good, maintainable code therefore becomes an important part of the documentation and being realistic about this from the start probably improves your "reference" or "manual", where it's better to focus on high-level or architectural concepts, and link to where to find the nitty-gritty in source.
Unfortunately you are never going to see a project with comprehensive documentation, I'm not sure what that would even look like.
It probably would look like Tex, FWIW.
Edit: I move to the bookcase to look at TeX: The Program. There it is sitting next to my volumes of TAOCP. A reminder of my failures. I can almost feel the disaproving gaze of D. E. Knuth. I'm not worthy.
Comments
The article aptly describes what it's like to start working with essentially any large code project, be it open source or proprietary. Unfortunately you are never going to see a project with comprehensive documentation, I'm not sure what that would even look like.
Good, maintainable code therefore becomes an important part of the documentation and being realistic about this from the start probably improves your "reference" or "manual", where it's better to focus on high-level or architectural concepts, and link to where to find the nitty-gritty in source.
It probably would look like Tex, FWIW.
Edit: I move to the bookcase to look at TeX: The Program. There it is sitting next to my volumes of TAOCP. A reminder of my failures. I can almost feel the disaproving gaze of D. E. Knuth. I'm not worthy.