Re:Essential elements of good documentation
by kaycebasques on Wednesday October 23, 2019 @08:26PM
(#21340492)
On web.dev we've started to create documentation quality guidelines [1] and a concrete, step-by-step checklist for ensuring that each document meets our quality guidelines. Long-term plan for the guidelines is to prioritize them based on research, and to link to research justifying why each guideline maps to quality. Feedback welcome, and LMK if you know of any other "style guides" already doing this.
[1] https://web.dev/handbook/quality/
[2] https://web.dev/handbook/content-checklist/