Re:Ask HN: How well maintained is the documentation in your ...
by Grimm1 on Monday May 17, 2021 @03:32PM
(#27187361)
First, thank you. You sound like a very conscientious person.
Second yeah that is generally what I've run into it's often one or a few people writing documentation that really benefits the organization but other people don't carry the weight and so when that person leaves it starts to harm the company as docs drift out of being current and no new docs are created, it is a slow burn though.
I wonder how we could reduce friction so more devs start to write code, that they clearly know they benefit from.
Every other tech loves and makes use of my documentation - it is one of the most referenced things in the company even by the techs who should be the ones writing the documentation for their code in the first place. Most of the existing documentation is documenting the undocumented features released by another tech department. I left the company for a year and when I returned there were only 3 new additions to the documentation, each one minor, and about 15~ new, undocumented features for our next iteration of our product. I've spent the last few weeks digging into the code and writing documentation for these new editions.
If I didn't care about documentation as much as I can't imagine there would be any documentation at all.