3 ms·
How do you improve code quality at your company? Probably by code review. The same works for technical writing. Have them review each other's documents. Not ju
by munificent 4y ago
How do you improve code quality at your company? Probably by code review.
The same works for technical writing. Have them review each other's documents. Not just for correctness, but for clarity and quality of writing.
- ioblomov 4y agoAs a 20-year full-stack veteran (and once-upon-a-time English major), I second this. Even the best writers in literature had editors. To gamify documentation and review, add a static analyzer that measures documentation coverage to CI. Not sure what your stack is, but for Ruby one I've had success with was Inch: https://github.com/rrrene/inch https://github.com/rrrene/inch. Once documentation is incorporated into the workflow with metrics, it can be addressed along with any other technical debt, enabling the team to improve their writing over time.