|
|
|
|
|
by derryrover
1882 days ago
|
|
My experience so far when I wrote documentation for some pieces that I though needed it:
- Nobody asked for it
- Nobody reads it
- Nobody reviews it
- Nobody updates it
- It takes me over a day to write so I feel quite guilty wasting the time
- It is often not clear were I should locate it (as code comments? , in markdown file in repo? In knowledgebase wiki? Some other pile of corporate docs?) When I talked to my successor about some piece of code a year later he told me how hard it was to refactor and (jokingly) that they pissed of a client breaking a bunch of features while refactoring it.
I mentioned the documentation about it, but apparently he did not even notice it existed (seemed also not interested in it). I guess my fault for not just saving it as markdown in our repo, but instead saving it in a document in our knowledge base (as was according to protocol). |
|