Хелп на тулз
Это не я кричу “Хелп” - это я его сегодня писала. Тулз был написан ещё до нового года, после периодически к нему возвращались - где-то добавить чуток функциональности, где-то поправить под новую функциональность дизайн (в тему прошлого поста про масштабируемый дизайн для всяких веб-бета-версий, кстати). Помимо прочего (основное назначение тулза - как раз такая генерация скина расширенными опциями, загрузка картинок, подключение этих картинок в качестве фоновых с задаваемыми же параметрами, оформление различных заголовков-текстов-ссылок, и прочий мрак - но генератор не очень элементарный) в тулзе были предусмотрены 26 готовых пользовательских скинов, сделанных нами же.
Заказчик покрутил тулз, поюзал его на своих юзерах, провёл личное маркетинговое исследование и выяснил, что ручным генератором пользуется крайне малое количество его юзеров. Все грузят готовые скины - из вот тех самых 26 заранее созданных. Теперь он собирается своими уже силами, вернее силами своих дизайнеров развивать именно этот раздел - т.е. присадить дизайнеров на изготовление шаблонов. Вот для них и пришлось писать хелп - что и как нужно сделать, по шагам, подробнейшая инструкция. Как же это сложно - описать внятным языком такие простые, как мне кажется, операции. Особенно повеселило описание файла инструкций (скриптам) - все инструкции задаются в .xml файле, и помимо прочего пришлось чуть ли ни для каждого шага подчёркивать, что нужно крайне внимательно следить за синтаксисом, цвет задавать через #, не удалить случайно какую-нибудь скобочку и прочий бред.
Пришлось опять представлять себя новичком-блондинкой, пытающейся изучить мой собственный хелп - всё ли там понятно, все ли тонкие места описаны, все ли строгие моменты выделены жирным шрифтом. Особенно повеселило описание блока Additional Style - собссно блок, в котором, при наличии небольшого опыта и знаний css можно перезаписать все объявленные в предыдущих операторах инструкции, и даже поменять оболочку тулза.
Мне показалось, что всё написано внятно и красиво. Отдаю текст переводчику. Судя по его комментариям… Нет, время конечно покажет, заказчиковые дизайнеры может и поумнее будут, разберутся, но есть такое подозрение, что будет в ближайшее время заказ на тулз для тулза - механизм создания скина для дизайнеров. Разница только в том, что простому юзверю отдаётся конечное количество полей для изменения, в ряде полей - конечное количество значений, типа по условиям ТЗ для тулза это такая защита от дураков (как всегда, не изобретательных, разумеется), создатель же скина (модер-дизайнер) имеет большее степеней свободы как при управлении графикой для скина, так и при всём остальном оформлении. Собственно весь хелп - как раз и есть инструкция о том, в чём эта большесть заключается. Но вот в чём прикол. Чем подробнее начинаю расписывать - тем больше этот хелп-документ напоминает документацию по основам css, если не дословную спецификацию с w3c, то не бедное такое пособие по возможностям таблиц стилей - что сделать, чтобы получить такой-то эффект, какие варианты совместного использования таких-то значений таких-то правил. Какие картинки можно использовать как паттерн (где background-repeat:repeat, repeat-x или repeat-y), и как эти картинки подготовить, какие - нельзя. Жуть.
И вот ведь в чём главная беда. Чем более подробной становится инструкция, тем сложнее её читать и тем более пугающим и непонятным становится хелп. Всё-таки в простом хелпе должно быть не больше 10 чётко сформулированных абзацев в нумерованном списке и никак иначе, остальное - ненужная детализация, по всей видимости. Что же делать?
No comments yet.