Если когда-нибудь сообщество разработчиков ПО решит учредить и вручать награды за самую медвежью услугу отрасли, какую-нибудь золотую кастрюлю или фигу с «кристаллами Сваровски», у меня есть первый кандидат. Уже много лет испытываю страстное желание ласково поглядеть в глаза тому, кто первый придумал, что «документацию никто не читает».
Самое забавное — эта чушь и ересь, похоже, распространяется воздушно-капельным путем среди менеджеров, руководящих проектами разработки. В нашем отечестве зараза, кажется, не миновала никого. Документацию в результате большинство отечественных фирм-разработчиков составляет по остаточному принципу, подверстывая материалы к релизу в стиле _ну-ка-поглядим-что-у-нас-вышло_. Логика понятна — в процессе разработки вроде бы не до усилий, которые не дадут немедленного результата. Да и потом, чего стараться, если все равно «документацию никто не читает»?
Попробую вообразить на миг, что автор вышеупомянутого гениального изречения однажды увидит эти строки. Так вот, дорогой друг, у меня есть для тебя потрясающая новость! Документацию читают! Еще как читают, представь себе. Самое интересное — кто это делает. Таких, в основном, можно разделить на две категории:
1) Те, кто хочет разобраться, как же программа должна работать по задумке ее авторов.
2) Те, у кого с программой возникли проблемы.
Иными словами, это большинство думающих пользователей. А теперь угадайте с трех раз, кто из них останется пользователем программы, в которой «мануал» и «хелп» запутывают больше, чем помогают, или вообще слабо соответствуют тому, что человек видит на экране. У скольких из них появится желание заплатить за следующую версию?
Некоторые компании, переболев и наступив на все мыслимые грабли, все же начинают закладывать подготовку документации и системы помощи в этап проектирования, составлять словари/глоссарии базовых понятий, учат разработчиков и технописов использовать именно ту терминологию, что введена в словарях, в общем, вкладываются в читаемость и понятность документации. Большинство, увы, так и продолжает энергично убивать сотни и тысячи рабочих часов на латание и перелатывание с каждой новой сборкой там, где проще отформатировать все и сделать заново по уму. Стоит ли удивляться только, когда наши передовые безо всяких кавычек продукты обходят на поворотах «непродвинутые» заграничные конкуренты с дружелюбным интерфейсом и понятной системой помощи?
|
Как техписатель, подписываюсь под каждым словом.
От себя: не могу не упомянуть про «нежную любовь» разработчиков к технопису, задающему неудобные вопросы, и синдром «документация нужна вчера», периодически возникающий у Самого Большого Начальства.
Вкусно написано, живенько и «с пульсом». 🙂 Оно и понятно: выстраданное всегда «выстреливает».
О, то ли еще будет, у меня такого выстраданного много в обойме. 🙂
Ждем-с 🙂
Кстати, в декабре-январе доводилось переводить мануал к тренингу по одной хитрой и прикольной софтине. Роль техписа там явно исполнил кто-то из программеров. Это было нечто, да.
Лучший способ — писать документацию прямо в коде.