|
|
|
|
|
by YZF
4621 days ago
|
|
Exactly. This "code is the documentation" mentality is simply laziness or an excuse for poor engineering. How about "the bridge is the documentation" for civil engineers? Or "the house is the documentation" who needs building plans? Documentation also has to cover larger scale interactions, that is how objects interact with each other and how they fit into the design. All that said, in a large software project you need to pick your battles. Maintaining the same level of documentation across the board and throughout the life of the software is very difficult. Make sure though that your core is well documented and you keep that documentation up to date. Libraries and APIs used externally also need to be well documented. |
|