Наша команда много лет занимается разработкой программы для создания пользовательской документации. За это время мы столкнулись с бесчисленным множеством руководств, анализировали и проверяли документацию наших клиентов, создавали свою собственную документацию, добавляли новые фичи и так далее.

В общем, наш путь был долог и интересен, но он еще далеко не закончился. Сегодня хочу поделиться с вами опытом технического писателя и в немного (или много) сатирической форме предостеречь от классических, но очень серьезных ошибок при написании и публикации пользовательской документации, с которыми часто сталкивались в руководствах наших клиентов.

И так, поехали – 8 классических способов сделать вашу документацию ненавистной для пользователя.

Читать далее

https://habr.com/ru/post/703358/?utm_source=habrahabr&utm_medium=rss&utm_campaign=703358