3 ms·
First of all you need an interalized conviction, based maybe on long and painful experience, that good docs are worth the trouble that it takes to write them.
by throwaway81523 4y ago
First of all you need an interalized conviction, based maybe on long and painful experience, that good docs are worth the trouble that it takes to write them. Second, your management has to back you up on this, when normally they are obsessed with slamming today's feature out the door and letting the underlying confusion keep piling up. And third, you have to put in the work of actually writing the docs. It's not the world's most challenging or demanding work, but it takes understanding of the topic you are writing about, and sustained effort to keep the words flowing into your keyboard.
There is not a stimulating code-test-debug cycle in writing like there is in programming. It's just work work work. There is no framework or tech stack that can change this. So you have to like writing, and think that it is worth it. You have to deal with that first. Worry about subtleties later.