[Apelsinov]

Интересуют идеи и мысли по этому поводу.
Вот такой разговор произошел у меня по аське с Крысом:

A 25.07.20 10:58 у меня, как обычно вопрос. не срочный. принципиальный. Про создание хелпа к своим прогам. в чем лучше его делать? K 25.07.20 10:59 По-моему, кто в чем делает. Я пока хелпами не занимался. Ща посмотрю, что у меня есть K 25.07.20 11:00 Черт, проги дома. http://www.google.ru/search?hl=ru&q=helpworkshop& tnG=%D0%9F%D0%BE%D0%B8%D1%81%D0%BA+%D0%B2+Google& r= Это с наскоку, что вспомнил A 25.07.20 11:08 я наверное не до конца понимаю что именно хочу: - в хелпе должен быть текст + иллюстрации - должно быть оглавление со ссылками - изменения должны вноситься легко и быстро (они будут вносится постоянно) - читаться должно на любом компе. - обьем хелпа небольшой - грузится будет по сети. - лучше, если будет какая-то система отслеживания изменений, то есть запустил юзер на своем компе хелп - а там ему - новое то-то и то-то. K 25.07.20 11:09 Вопрос - а ты как хелп вызывать собираешься? K 25.07.20 11:09 Лиспом или иными средствами? A 25.07.20 11:09 лиспом A 25.07.20 11:10 вообще, я хочу - нажал кнопу на палитре - получи хелп. K 25.07.20 11:11 Ок. Тогда при загрузке всех своих, например, можно сделать так: Смотришь локальный txt-файл, в котором записана версия хелпа, к примеру. Ищешь его по указанному заранее адресу на серваке. Если сервачный вариант такой же, то работать дальше, иначе - мессага. А сам хелп сделать html-ным и вызывать как (startapp "iexplode.exe") - с передачей страницы по умолчанию. Ну или что-то такого типа. A 25.07.20 11:20 ну мысль интересная, не совсем так, но я думаю, что воплощу в жизнь, спасибо за идею. - это про мессагу с новым. а все таки хелп в html - это здорово, в смысле формата, но не очень в создании, мне по крайней мере. Задолбаюсь я в html ручками его писать, а потом править. K 25.07.20 11:21 FrontPage A 25.07.20 11:22 хрен редьки не слаще.... мне бы что нибудь попроще K 25.07.20 11:22 Куды уж проще-то? Не, можно, конечно, Dreamwaver пришарашить, но FrontPage, по-моему, попроще в обращении будет

[_Andre_]

Делаю HTML-страницы, храню на сервере (впрочем как и все остальное для автокада), таким образом не требуется никаких специальных мер для обновления справки у всех пользователей.

Страницы делаю в WORD - наверное в Frontpage или еще где то проще, но вроде пока особого дискомфорта не ощущаю.

Справка сделана по приницпу - оглавление - ссылки на разделы и далее на конкретные функции.

[VVA]

Очень похоже как _Andre_. Только файл в формате mht - архивный HTML (текст и графика в одном флаконе). Удобно, потому что 1 файл. Можно хранить локально. Готовлю в Word Файл->Сахранить как ->Веб страница в одном файле. Кнопочка на панели вида

Код:

[Выделить все]

^C^C^P(if (setq PICK1 (findfile "mipgost.mht"))(command "_.BROWSER" PICK1)(alert "Невозможно найти файл mipgost.mht"));^P

[alle]

Сообщение от Apelsinov

[/quote]

обычно chm или hlp. Есть бесплатные проги в интернете. chm компилируется из html страниц (со всеми связями и т.д). для hlp шных файлов есть специальная надстройка к Word.

[ShaggyDoc]

Существует много специализированных программ для создания справок. Перебрав разные, я остановился на Help & Manual.

Позволяет делать и HLP и CHM. Работа очень простая, любая структура справки. Все, что должно быть в профессионально сделанной справочной системе.

Особое достоинство - позволяет создать проект, декомпилировав любой существующий файл справки.

Кроме того, из одного проекта позволяет создать не только справку, но и Руководство в формате RTF или PDF - со всем необходимым оформлением. Надо только правильно подготовить шаблоны.
[ATTACH]1153823082.gif[/ATTACH]

[KAI]

А я привык к Robohelp. Интегрирован в Word, а там все знакомо.

[Pilot]

Когда-то начал писать хэлп к своим прогам, но через некоторое время остыл.
Выяснилось:
- если прога имеет тот самый пресловутый "интуитивно-понятный" или "дружественный" интерфейс, то и хэлп особенно не нужен.
- писать хэлп значительно менее интересно, чем сами проги.
- самое главное: хэлп все равно никто не читал, поэтому:
- объяснить "как это работает" тем полутора десяткам пользователей в своем и смежных отделах можно быстрее и доходчивее вживую.


Но другое дело, если юзеров много.


Выражаю сомнение в идее держать хэлп на сервере.
У тебя сами проги размещеются на локальных машинах? Дсли да, то пусть и хэлп там же будет. Причем версия_проги=версии_хэлпа. А о новинках лучше извещать отдельно, можно как по технологии "пул" так и по "пуш".

[_Andre_]

Проги тоже лежат на сервере. Достаточно проблематично обновлять файлы на 300 машинах. Хотя я и не питаю иллюзий, что все 300 человек используют эти проги, но все же удобнее всё держать на сервере.

О новинках извещаю через вывод информации в командной строке.

[Pilot]

Сообщение от _Andre_ О новинках извещаю через вывод информации в командной строке.

А может лучше через (alert... ? Так заметнее.

[Apelsinov]

Сообщение от Pilot Когда-то начал писать хэлп к своим прогам, но через некоторое время остыл. Выяснилось: - если прога имеет тот самый пресловутый "интуитивно-понятный" или "дружественный" интерфейс, то и хэлп особенно не нужен. - писать хэлп значительно менее интересно, чем сами проги. - объяснить "как это работает" тем полутора десяткам пользователей в своем и смежных отделах можно быстрее и доходчивее вживую. - самое главное: хэлп все равно никто не читал. Но другое дело, если юзеров много. Выражаю сомнение в идее держать хэлп на сервере. У тебя сами проги размещеются на локальных машинах? Дсли да, то пусть и хэлп там же будет. Причем версия_проги=версии_хэлпа. А о новинках лечше извещать отдельно, можно как по технологии "пул" так и по "пуш".

>юзеров то не оч. много, и я в принципе могу даже к каждому подойти и объяснить, но по одному, а не по 5 раз. И к тому-же есть вещи, которые лучше объяснять в письменной форме.
Проги находятся на сервере, с него и грузятся, либо стоит синхронизация с сервером.
Что есть пул и пуш?

[Pilot]

2 Apelsinov
Я делал так:

Когда сварганивал что-либо стоящее, то рассылал обновления и собирал 7-8 человек из нашего отдела - объяснял и показывал. Обычно хватало 5 минут.

Народ в других отделах я только усно извещал об изменения. Как это ни цинично, производителльность их труда меня не очень интересовала. Заинтересуются - сами спросят.

Пусть программисты-профессионалы меня поправят, если ошибаюсь:
pull - технология обновлений прог по запросу пользователя.
push - при установлении соединения с сервером/инетом/другим_источником_данных обновление производится автоматически, а при определенных настройках даже без запроса разрешения пользователя.

[_Andre_]

Про (alert...) расценил как шутку =)

Хотя мысль такая и была - но как мне показалось - назойливое мелькание окошка при открытии файла принесет больше вреда чем пользы.

Как показала практика - кому интересно - увидят то что и в командной строке, а кому по барабану - хоть плакат вешай на монитор - пользоваться не будут.

[Pilot]

2 _Andre_
Я про (alert вполне серьезно. Конечно, если обновления поступают по нескольку раз в день, то это будет раздражать.
А если раз в неделю - то почему бы и нет.
Вдобавок несложно сделать так, чтобы сообщение о новинках появлялось только один раз в день, а не при каждом открытии чертежа.

[_Andre_]

Согласен абсолютно со всем написанным. Про единократное появления окошка тоже думал, но так и не стал делать. Почему, не знаю =(

[ShaggyDoc]

Все-таки разные темы - надо ли вообще делать справку и технология ее изготовления.

Многие авторы считают, что вообще не надо. У них, мол, "интуитивно понятно". На самом деле - просто лень, некогда, муторно. Ни один программист не любит документировать программы!

У буржуев бывает наоборот - на никчемную, простенькую программу составляют груду документации. Иначе у них программы в софтовые каталоги просто не берут.

Я сослался на Help & Manual как на удобный инструмент. Есть и другие (Robohelp, HelpScribble и т.п.). Самый неудобный способ - технология Microsoft - подготовка RTF, проекта, компилирование и т.д.

Но, в зависимости от сложности программы, справки можно делать разными. Не исключается и простой Alert. Я его включаю в некоторые потенциально опасные программы. Не очень-то раздражает, но помогает, в том числе и самому.

Возможно делать и простые текстовые файлы, и HTML. Выбор только по вкусу и исходя из минимума собственных трудозатрат. Но важно, чтобы справку (любую) можно было вызвать из программы, а не искать ее где-то на диске.

В системе BestIA у меня была вообще справка на сайте. Но это не прижилось - все-таки не все пользователи имеют постоянный доступ в Сеть.

[===AAA===]

Привет!

Вот сделать так, чтобы пользователь _захотел_ прочесть
хелп - действительно сверхзадача.

У меня сделано так: при открытии юзером чертежа из
новой папки (список ранее использованных папок
запоминается) появляется окошко с КРАТКИМ (4 строки)
описанием "новинок".

Чтобы просто "тупо" не сбрасывали это окно пишу
"Введите ключевое слово" - оно написано тут же,
под текстом (типа, прочитаешь 4 строки - ключ увидишь).

Чтобы окна не примелькивались, при обновлении меняю
цвет окна и ключевое слово.

Сделано много проверок, чтобы эти окна появлялись
не часто и не раздражали.

Один черт - первым делом находят глазами "ключевое
слово" (типа, потом почитаем!) вводят, начинают работать...

А потом...

Ой, а мы и не знали, что такая возможность появилась!
Да, надо справку читать...

И все по кругу.

И таких юзеров 80-90% :-(((

[Кулик Алексей aka kpblc]

Хех, таймер поставь на ввод слова - типа если меньше чем 1 минута с момента скролла на окне текста, поле ввода ключа недоступно

[Pilot]

Ну-ну. Продолжаем издеваться над юзерами. Я тоже через это проходил (Имея меркантильный инетерс, между прочим. Заставлял приобретать у меня каждую свежую версию.). Потом смирился - все же живое общение оказалось эффективнее. Но - подчеркну - в небольших масштабах.

[KAI]

ShaggyDoc Ни один программист не любит документировать программы! Но важно, чтобы справку (любую) можно было вызвать из программы, а не искать ее где-то на диске. ===AAA=== Вот сделать так, чтобы пользователь _захотел_ прочесть хелп - действительно сверхзадача.

Категорически согласен.
"Не любит" - это мягко сказано. Но надо!!! Юзера надо ЛЮБИТЬ, и облегчать ему жизнь.
Пусть хоть трижды интуитивный интерфейс, но, согласитесь, (почти) в любой программе найдутся исключения, при которых она не работает, или работает "не по интуиции". Вот это в первую очередь и нужно, по моему, описывать в Help. Да еще описание опций (кратенько так). Сколько раз ловил себя, что пропускал в некоторых командах AutoCAD очень интересные опции для новых версий (работаешь на автомате, на COM строку не смотришь).

Что делает юзер, когда программа "не идет", особенно та, в которой он постоянно работает?
1. пробует еще и еще... раз.
2. начинает читать подсказки в командной строке, и может быть даже нажимает на F2.
3. спрашивает у соседа.
4. приглашает (звонит) гуру.
5. и наконец Продвинутый Юзер пишет письмо разработчику, спрашивает на форумах или нажимает на F1!!! и читает Help (УРА!).

Вывод: Help - это архиважно. Исключение - программы и функции только для собственного употребления, да и то нужно не забывать о документировании в коде, а то лет через несколько сам не вспомнишь, что наваял.

[Alxd]

Скромно добавлю, что во всем согласен с ShaggyDoc и KAI