На чтение кода уходит в десять раз больше времени, чем на его написание. Поэтому разработчики затачивают код под читателя: заморачиваются с именами переменных, добавляют отступы, следуют соглашениям.
Документация обычно выглядят не такой чистой, как код. Наверное, потому что писать документацию сложнее. С ней тебе не помогает компилятор, IDE и тесты.
Но помочь писателям хочется. Им много не надо, достаточно посмотреть на статью глазами читателя. Для этого есть инструменты.
10% zoom
Самый простой и безотказный вариант – это отзумить страницу до 10%. Если так делать, стена текста становится заметной даже для привыкшего к ней писателя. Аккуратный микс картинок, текста и заголовков тоже сразу заметен, он говорит о качестве.
Skimmer’s view
Другой вариант – вырезать со страницы всё лишнее, как на картинке ниже. Это делается с помощью букмарклета, вырезающего все параграфы, списки, цитаты и блоки кода со страницы. Эту ссылку можно перетащить в панель закладок, по клику она отобразит страницу так, как её видит бегло читающий человек. Пример ниже.
Хорошо, когда писатель понимает читающего по диагонали человека.