4 ms·
The single best thing you can do for good documentation is to hire actual technical writer. Someone who already knows how to write in general, how to write and
by watwut 6y ago
The single best thing you can do for good documentation is to hire actual technical writer. Someone who already knows how to write in general, how to write and structure technical texts specifically and who wants to write.
It has three advantages:
- They are cheaper then programmers.
- They write faster then programmers.
- Unlike programmers, they produce well structured easy to read text.
And bonus: if you are lucky, they will be able to explain to programmers how to write better. They won't make them into James Joyces, but will make them learn a bit. It will take time and only some programmers will improve, but the technical writers has that effect.