Комментарии 4
К последнему пункту есть антоним - когда есть только видео. И чтобы что-то узнать нужно смотреть видео, в которое ещё наверняка интро и вступительное слово запихали.
Имхо, распространенная ошибка при написании документации, или справочной системы для прикладного ПО - поручить ее написать программисту.
По моему опыту, обычно ничего удобочитаемого из этого не получается. Исключения бывают (только если ПО предназначено для программеров), но это случается редко.
Писать мануалы для любого достаточно сложного прикладного ПО должен человек, который является профессионалом в той предметной области, для которой разрабатывается это ПО. То есть, если софтина предназначена для использования (например) медиками, то написание текстов для всех мануалов и хелпов нужно поручать врачу. Да не абы какому врачу, а такому, который:
А. уже хорошо освоил эту софтину (весьма желательно, чтобы он сам участвовал в ее создании и тестировании),
Б. у которого хорошо получается излагать свои мысли в письменном виде.
Программеру можно поручить написание текста инструкций на начальных этапах, но после этого все равно должен кто-то из "понимающих людей" пройтись по всему тексту и "творчески его переработать".
В крупных организациях есть должность "технического писателя", а в мелких стартапах программер работает обычно в режиме "и швец, и жнец, и на дуде игрец". Это не хорошо и не плохо. Это как есть. Продуманную архитектуру, удобный пользовательский интерфейс он создать сможет. И код хороший напишет. Но вот написать качественный мануал - уже вряд ли. Потому что он напишет его для себя, а не для потенциального пользователя.
Естественно, все вышесказанное касается только написания текстов. Вопрос их оформления, форматирования, рисования картинок и диаграмм - это немножко совсем другое.
P.S.: В своё время занимался внедрением и поддержкой как раз медицинского софта, и штат у нас был очень маленький.
Мне кажется, фундаментальная проблема авторов инструкций для пользователей - отсутствие заботы об этих самых пользователях. Осознать это и улучшить качество, в частности, инструкций неплохо помогает книга "Пиши. Сокращай".
Почему пользователи не читают документацию или как можно улучшить руководство пользователя 2