|
|
|
|
|
by danny_codes
1299 days ago
|
|
I think most of us approach documentation without intention. We write to express the idea, but fail to consider how the documentation fits into the deliverable. For example, one could structure things where the English documentation is the deliverable. The code merely serves to actualize the document. In this world, we would consider the act of writing documentation of paramout importance, whereas the code is an implementation detail. I think software as a discipline is distinctly undiscipled about these sorts of concepts. |
|
Documentation is useful when it's job is to help understand why the code is the way it is, what problems are trying to be solved, and what constraints the devs had.