Хабы: Программирование, Анализ и проектирование систем, Управление разработкой, Подготовка технической документации
«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей.
Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда.
Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.
Читать далее