Про хелпы

В “Компьютерре” в очередной раз собирают вопросы для интервью “по заявкам радиослушателей”. На этот раз вопросы для RITLabs (авторы популярного почтовика The Bat). Ну а т.к. сам я давний поклонник и пользователь Бата, конечно же с интересом полистал. Вопросы задавать не стал, чтобы не добавлять лишней цензуры работы админам, благо у меня они как всегда и едкие, и специфичные. Но сами вопросы пользователей читал с превеликим интересом, благо считаю что Бат один из мощнейших  почтовиков, хотя и с такими же мощными “косяками” (сие не про баги)

А заинтересовал весьма любопытный, злободневный и до боли знакомый вопрос: “почему включенная в состав почтового клиента справочная документация так редко обновляется и постоянно отстает от текущей версии?”.

Хороший вопрос! Годный!
Действительно, частенько хелпы пишутся формально, да еще и с приличным опозданием. Хм, а почему? Вопрос вечный: что раньше, курица или яйцо? Да и так ли важен ответ? Важнее почему пользователь читает старые\неверные хелпы, а как и когда они пишутся это уже детали.

У меня русский хелп к Aml Pages пишется в последний момент да все больше наскоками. Поэтому и вкладывать его в дистрибутив с новой версией попросту нет смысла: версия новая, а дока к ней еще старая. Выкрутился так: русская справка распространяется отдельно (правда, если уж руку на сердце положа, на то было и еще две весомых причины: справка появилась значительно позже, да и весит она в ZIP-архиве как весь остальной дистрибутив вместе взятый).

Но “изюминка” в интеграции Aml Pages и ее справки. Любая попытка обратиться к хелпу, сначала проверяет его наличие и если его нет, сразу предлагает скачать справку с сайта по прямой ссылке.
Такой вариант позволяет выпустить новую версию, и спокойно с недельку “причесывать” справку. Опять же старинные и активные пользователи про такое небольшое отставание в курсе.
А новые… Эх, новые… Да не будут новые пользователи первым делом шариться по справке!
Вы когда-нибудь начинали знакомство с софтом с активного изучения доки? (вот только врать не бум, ладно:). Ну, а когда новый пользователь доходит до незабвенной кнопки F1, ему тут же предлагается скачать справку (повторюсь: ссылка прямая, никаких заходов, подтверждений и.т.п. – число кликов минимально).

Вот такой вот компромисс. Всё лучше, чем вкладывать старый вариант справки. Imho, в данном случае лучше никак, чем плохо. Когда справки нет, то пользователь скачает ее потом по прямой же ссылке. Если же справка есть, но неполная, врёт, да по старой версии, то никакой пользователь никогда не догадается что-то там обновлять только из-за справки – он воспримет подобную справку как унылое бесполезное гавно, написанное для отмазы, и тут же забудет о её существовании. В варианте с прямой гиперссылкой шансы все-таки есть. Лучше поздно, чем в штаны.

Впрочем, не буду голословным. Статистика радует – соотношение скачивания справки и самого дистрибутива 1 : 2. Т.е. половина все-таки скачивает!
Любопытны отзывы о справке. Девелоперы и прочие коллеги: “так нельзя!” (мама запретила, Билли обругает). Пользователи: отзывы всё более в превосходной степени “великолепная”, “отличная”.

Понимаю, что эти цифры говорят нечто о скачавших и только о них. И ни черта не сообщают о тех, кто остался без справки. О них можно просто ничего не узнать. Но вот какая загвоздка… Те кто не скачали справку, они всего лишь не_скачали. Возможно они и не пытались – справка не нужна им в силу квалификации, их не устраивает эта софтина в принципе, на первом этапе знакомства им достаточно технической поддержки!?! Конечно, число “обломившихся” неизвестно, но точно понятно, что они не вся эта “потерянная” половина.

Зато по крайней мере те, кто все-таки справку искал, F1 нажимал – получают ее в приемлемом виде, а не формально вложенную в дистрибутив, лишь бы отвязались. Проще говоря, тем кому справка нужна – получают ее и в актуальном виде. Тем кому нет – на нет и суда нет.

“Чота” расписался я сегодня… Вообще про документацию можно говорить много, но на сегодня “харе”. Про способы написания доки, про зачем оно “надо” пользователю, а зачем разработчику, и чем эти “нада” отличаются как-нибудь в другой раз.