4 ms·
> good sign your documentation has some challenges: dense; intimidating; inaccessible; or not easy to search for the specific information you want Of course it
by prepend 28d ago
> good sign your documentation has some challenges: dense; intimidating; inaccessible; or not easy to search for the specific information you want
Of course it does. And it’s not “my documentation” it’s ours. And everyone is responsible for improving it. It’s not about pointing out that documentation sucks, it’s about working to improve it.
I don’t have a documentarian on my team. No one’s main job is to write docs. So we all get to help each other by gradually improving the docs. And if I help someone with something not in the docs then the recipient gets to include that missing info into the docs to help the next person.
We also added a hat for a rotating role called “Benevolent Documentation Czar for the Quarter” where that person gets to explicitly improve team docs. Maybe like 5% of their time.